asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generated references after collapse types improvement (#11889)

Browse Source
This commit is contained in:
Shahed Nasser
2025-03-18 16:48:43 +02:00
committed by GitHub
parent d0ca0f5ce0
commit ac24749bd3
774 changed files with 1612 additions and 1628 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionBuyRules/page.mdx
+1 -1
View File
@@ -40,4 +40,4 @@ const buyPromotionRules =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PromotionRuleDTO","type":"`object`","description":"The promotion rule details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addPromotionBuyRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[PromotionRuleValueDTO](../../../interfaces/promotion.PromotionRuleValueDTO/page.mdx)[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the promotion rule value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`null` \\| `string`","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addPromotionBuyRules"/>
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionRules/page.mdx
+1 -1
View File
@@ -40,4 +40,4 @@ const promotionRules =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The promotion rules created.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PromotionRuleDTO","type":"`object`","description":"The promotion rule details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addPromotionRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The promotion rules created.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[PromotionRuleValueDTO](../../../interfaces/promotion.PromotionRuleValueDTO/page.mdx)[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the promotion rule value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`null` \\| `string`","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addPromotionRules"/>
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionTargetRules/page.mdx
+1 -1
View File
@@ -40,4 +40,4 @@ const targetPromotionRules =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PromotionRuleDTO","type":"`object`","description":"The promotion rule details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addPromotionTargetRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[PromotionRuleValueDTO](../../../interfaces/promotion.PromotionRuleValueDTO/page.mdx)[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the promotion rule value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`null` \\| `string`","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addPromotionTargetRules"/>
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.computeActions/page.mdx
+1 -1
View File
@@ -54,4 +54,4 @@ const actions = await promotionModuleService.computeActions(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ComputeActions](../../../types/promotion.ComputeActions/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of computed actions to be applied on the cart.","expandable":false,"children":[{"name":"ComputeActions[]","type":"[ComputeActions](../../../types/promotion.ComputeActions/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ComputeActions","type":"[AddItemAdjustmentAction](../../../interfaces/promotion.AddItemAdjustmentAction/page.mdx) \\| [RemoveItemAdjustmentAction](../../../interfaces/promotion.RemoveItemAdjustmentAction/page.mdx) \\| [AddShippingMethodAdjustment](../../../interfaces/promotion.AddShippingMethodAdjustment/page.mdx) \\| [RemoveShippingMethodAdjustment](../../../interfaces/promotion.RemoveShippingMethodAdjustment/page.mdx) \\| [CampaignBudgetExceededAction](../../../interfaces/promotion.CampaignBudgetExceededAction/page.mdx)","description":"A compute action informs you what adjustment must be made to a cart item or shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="computeActions"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ComputeActions](../../../types/promotion.ComputeActions/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of computed actions to be applied on the cart.","expandable":false,"children":[{"name":"ComputeActions[]","type":"[ComputeActions](../../../types/promotion.ComputeActions/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"action","type":"`\"addItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the item's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="computeActions"/>
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.createCampaigns/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.createPromotions/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listCampaigns/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotionRules/page.mdx
+1 -1
View File
@@ -65,4 +65,4 @@ const promotionRules =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PromotionRuleDTO","type":"`object`","description":"The promotion rule details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listPromotionRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[PromotionRuleValueDTO](../../../interfaces/promotion.PromotionRuleValueDTO/page.mdx)[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the promotion rule value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`null` \\| `string`","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listPromotionRules"/>
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotions/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.retrieveCampaign/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.retrievePromotion/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.updateCampaigns/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.updatePromotionRules/page.mdx
+1 -1
View File
@@ -36,4 +36,4 @@ const promotionRules =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PromotionRuleDTO","type":"`object`","description":"The promotion rule details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePromotionRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated promotion rules.","expandable":false,"children":[{"name":"PromotionRuleDTO[]","type":"[PromotionRuleDTO](../../../interfaces/promotion.PromotionRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[PromotionRuleValueDTO](../../../interfaces/promotion.PromotionRuleValueDTO/page.mdx)[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the promotion rule value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`null` \\| `string`","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePromotionRules"/>
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.updatePromotions/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long