docs: [20/n] generate core-flows reference (#8803)

This commit is contained in:
Shahed Nasser
2024-08-27 12:25:05 +03:00
committed by GitHub
parent c617dc873b
commit 40330650e4
7 changed files with 1829 additions and 0 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,69 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Workflows\_Pricing
## createPricePreferencesWorkflowId
`Const` **createPricePreferencesWorkflowId**: `"create-price-preferences"`
___
## deletePricePreferencesWorkflowId
`Const` **deletePricePreferencesWorkflowId**: `"delete-price-preferences"`
___
## updatePricePreferencesWorkflowId
`Const` **updatePricePreferencesWorkflowId**: `"update-price-preferences"`
___
## createPricePreferencesWorkflow
This workflow creates one or more price preferences.
### Steps
<WorkflowDiagram workflow={{"name":"createPricePreferencesWorkflow","steps":[{"type":"step","name":"createPricePreferencesStep","description":"This step creates one or more price preferences.","link":"../core_flows.Steps_Pricing/page.mdx#createpricepreferencesstep","depth":1}]}} />
### Input
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
### Output
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
___
## deletePricePreferencesWorkflow
This workflow deletes one or more price preferences.
### Steps
<WorkflowDiagram workflow={{"name":"deletePricePreferencesWorkflow","steps":[{"type":"step","name":"deletePricePreferencesStep","description":"This step deletes one or more price preferences.","link":"../core_flows.Steps_Pricing/page.mdx#deletepricepreferencesstep","depth":1}]}} />
### Input
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesWorkflow"/>
___
## updatePricePreferencesWorkflow
This workflow updates one or more price preferences.
### Steps
<WorkflowDiagram workflow={{"name":"updatePricePreferencesWorkflow","steps":[{"type":"step","name":"updatePricePreferencesStep","description":"This step updates price preferences matching the specified filters.","link":"../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesstep","depth":1}]}} />
### Input
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
### Output
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long