chore(docs): Generated References (automated) (#11579)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
759 files changed
+428283
-416492
No files matched your search
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ApplicationMethod data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping\\_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"BelongsTo<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotion.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandableLine truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"BelongsTo<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotion.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":Line truncated
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Campaign data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](./page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date that the campaign starts.","optional":true,"defaultValue":"",Line truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](./page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date that the campaign starts.","optional":true,"defaultValue":"",Line truncated
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Promotion data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](./page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModLine truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](./page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModLine truncated
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PromotionRule data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](./page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](./page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_Line truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](./page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](./page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_Line truncated
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PromotionRuleValue data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](./page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Line truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](./page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Line truncated
|
||||
Reference in new issue
Block a user