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

chore(docs): Generated References (automated) (#10276)

Browse Source 
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-11-26 09:24:41 +00:00
1 parent 67e2e718e9
commit d5ee0070b4
928 files changed
+182409 -172163
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listAndCountCampaigns/page.mdx
+1 -1
View File
@@ -61,7 +61,7 @@ const [campaigns, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)","description":"The filters to apply on the retrieved campaigns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to aLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)","description":"The filters to apply on the retrieved campaigns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to aLine truncated
## Returns
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listAndCountPromotions/page.mdx
+1 -1
View File
@@ -61,7 +61,7 @@ const [promotions, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)","description":"The filters to apply on the retrieved promotions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget_id","type":"`string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by the ID of their associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Filter promotions by whether they're applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../types/promotion.PromotionTypeValues/page.mdx)[]","description":"Filter promotions by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","opLine truncated
<TypeList types={[{"name":"filters","type":"[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)","description":"The filters to apply on the retrieved promotions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget_id","type":"`string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by the ID of their associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Filter promotions by whether they're applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../types/promotion.PromotionTypeValues/page.mdx)[]","description":"Filter promotions by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","opLine truncated
## Returns
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listCampaigns/page.mdx
+1 -1
View File
@@ -58,7 +58,7 @@ const campaigns = await promotionModuleService.listCampaigns(
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)","description":"The filters to apply on the retrieved campaigns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to aLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)","description":"The filters to apply on the retrieved campaigns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterableCampaignProps](../../../interfaces/promotion.FilterableCampaignProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find campaigns by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the campaigns by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`[]","description":"Filters the campaigns by their campaign identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to aLine truncated
## Returns
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotionRules/page.mdx
+1 -1
View File
@@ -61,7 +61,7 @@ const promotionRules =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)","description":"The filters to apply on the retrieved promotion rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the promotion rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the promotion rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`[]","description":"The IDs to filter the promotion rules by.","optional":true,"defaultValue":"","Line truncated
<TypeList types={[{"name":"filters","type":"[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)","description":"The filters to apply on the retrieved promotion rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the promotion rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionRuleProps](../../../interfaces/promotion.FilterablePromotionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the promotion rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`[]","description":"The IDs to filter the promotion rules by.","optional":true,"defaultValue":"","Line truncated
## Returns
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotions/page.mdx
+1 -1
View File
@@ -58,7 +58,7 @@ const promotions = await promotionModuleService.listPromotions(
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)","description":"The filters to apply on the retrieved promotions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget_id","type":"`string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by the ID of their associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Filter promotions by whether they're applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../types/promotion.PromotionTypeValues/page.mdx)[]","description":"Filter promotions by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","opLine truncated
<TypeList types={[{"name":"filters","type":"[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)","description":"The filters to apply on the retrieved promotions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the promotions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget_id","type":"`string`[] \\| [OperatorMap](../../../types/promotion.OperatorMap/page.mdx)&#60;string&#62;","description":"Filter promotions by the ID of their associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Filter promotions by whether they're applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../types/promotion.PromotionTypeValues/page.mdx)[]","description":"Filter promotions by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/promotion.BaseFilterable/page.mdx)&#60;[FilterablePromotionProps](../../../interfaces/promotion.FilterablePromotionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","opLine truncated
## Returns
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.retrieveCampaign/page.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ const campaign =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the campaigns.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/promotion.FindConfig/page.mdx)&#60;[CampaignDTO](../../../interfaces/promotion.CampaignDTO/page.mdx)&#62;","description":"The configurations determining how the campaign is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a campaign.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/promotion.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/promotion.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKeyLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the campaigns.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/promotion.FindConfig/page.mdx)&#60;[CampaignDTO](../../../interfaces/promotion.CampaignDTO/page.mdx)&#62;","description":"The configurations determining how the campaign is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a campaign.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/promotion.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/promotion.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/promotion.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idemLine truncated
## Returns
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.retrievePromotion/page.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ const promotion = await promotionModuleService.retrievePromotion(
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/promotion.FindConfig/page.mdx)&#60;[PromotionDTO](../../../interfaces/promotion.PromotionDTO/page.mdx)&#62;","description":"The configurations determining how the promotion is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a promotion.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/promotion.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/promotion.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/promotion.FindConfig/page.mdx)&#60;[PromotionDTO](../../../interfaces/promotion.PromotionDTO/page.mdx)&#62;","description":"The configurations determining how the promotion is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a promotion.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/promotion.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/promotion.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/promotion.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the Line truncated
## Returns
www/apps/resources/references/promotion/interfaces/promotion.FindConfig/page.mdx
+1 -1
View File
@@ -13,4 +13,4 @@ which provides correct typing of field names in its properties.
<TypeList types={[{"name":"Entity","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/promotion.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
www/apps/resources/references/promotion/interfaces/promotion.IBigNumber/page.mdx
+9 -7
View File
@@ -6,15 +6,17 @@ import { TypeList } from "docs-ui"
# IBigNumber
## Properties
- [numeric](page.mdx#numeric)
- [raw](page.mdx#raw)
- [bigNumber](page.mdx#bignumber)
## Methods
- [toJSON](../../IBigNumber/methods/promotion.IBigNumber.toJSON/page.mdx)
- [valueOf](../../IBigNumber/methods/promotion.IBigNumber.valueOf/page.mdx)
<TypeList types={[{"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":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
## Properties
- [bigNumber](page.mdx#bignumber)
- [numeric](page.mdx#numeric)
- [raw](page.mdx#raw)
___
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
www/apps/resources/references/promotion/interfaces/promotion.IMessageAggregator/page.mdx
+2 -2
View File
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Methods
- [save](../../IMessageAggregator/methods/promotion.IMessageAggregator.save/page.mdx)
- [getMessages](../../IMessageAggregator/methods/promotion.IMessageAggregator.getMessages/page.mdx)
- [clearMessages](../../IMessageAggregator/methods/promotion.IMessageAggregator.clearMessages/page.mdx)
- [getMessages](../../IMessageAggregator/methods/promotion.IMessageAggregator.getMessages/page.mdx)
- [save](../../IMessageAggregator/methods/promotion.IMessageAggregator.save/page.mdx)
- [saveRawMessageData](../../IMessageAggregator/methods/promotion.IMessageAggregator.saveRawMessageData/page.mdx)
www/apps/resources/references/promotion/interfaces/promotion.IModuleService/page.mdx
+6 -4
View File
@@ -6,12 +6,14 @@ import { TypeList } from "docs-ui"
# IModuleService
## Properties
- [\_\_hooks](page.mdx#__hooks)
## Methods
- [\_\_joinerConfig](../../IModuleService/methods/promotion.IModuleService.__joinerConfig/page.mdx)
## Properties
- [\_\_hooks](page.mdx#__hooks)
___
<TypeList types={[{"name":"__hooks","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"onApplicationStart","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IModuleService"/>
www/apps/resources/references/promotion/interfaces/promotion.IPromotionModuleService/page.mdx
+26 -26
View File
@@ -19,32 +19,32 @@ The main service interface for the Promotion Module.
## Methods
- [registerUsage](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.registerUsage/page.mdx)
- [revertUsage](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage/page.mdx)
- [computeActions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.computeActions/page.mdx)
- [createPromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.createPromotions/page.mdx)
- [updatePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.updatePromotions/page.mdx)
- [listPromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotions/page.mdx)
- [listAndCountPromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listAndCountPromotions/page.mdx)
- [retrievePromotion](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.retrievePromotion/page.mdx)
- [deletePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.deletePromotions/page.mdx)
- [softDeletePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.softDeletePromotions/page.mdx)
- [restorePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.restorePromotions/page.mdx)
- [addPromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionRules/page.mdx)
- [addPromotionTargetRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionTargetRules/page.mdx)
- [addPromotionBuyRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionBuyRules/page.mdx)
- [removePromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.removePromotionRules/page.mdx)
- [removePromotionTargetRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.removePromotionTargetRules/page.mdx)
- [removePromotionBuyRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.removePromotionBuyRules/page.mdx)
- [createCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.createCampaigns/page.mdx)
- [updateCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.updateCampaigns/page.mdx)
- [listPromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotionRules/page.mdx)
- [updatePromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.updatePromotionRules/page.mdx)
- [listCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listCampaigns/page.mdx)
- [listAndCountCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listAndCountCampaigns/page.mdx)
- [retrieveCampaign](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.retrieveCampaign/page.mdx)
- [deleteCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.deleteCampaigns/page.mdx)
- [softDeleteCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.softDeleteCampaigns/page.mdx)
- [restoreCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.restoreCampaigns/page.mdx)
- [addPromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionRules/page.mdx)
- [addPromotionsToCampaign](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionsToCampaign/page.mdx)
- [addPromotionTargetRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionTargetRules/page.mdx)
- [computeActions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.computeActions/page.mdx)
- [createCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.createCampaigns/page.mdx)
- [createPromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.createPromotions/page.mdx)
- [deleteCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.deleteCampaigns/page.mdx)
- [deletePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.deletePromotions/page.mdx)
- [listAndCountCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listAndCountCampaigns/page.mdx)
- [listAndCountPromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listAndCountPromotions/page.mdx)
- [listCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listCampaigns/page.mdx)
- [listPromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotionRules/page.mdx)
- [listPromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.listPromotions/page.mdx)
- [registerUsage](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.registerUsage/page.mdx)
- [removePromotionBuyRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.removePromotionBuyRules/page.mdx)
- [removePromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.removePromotionRules/page.mdx)
- [removePromotionsFromCampaign](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.removePromotionsFromCampaign/page.mdx)
- [removePromotionTargetRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.removePromotionTargetRules/page.mdx)
- [restoreCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.restoreCampaigns/page.mdx)
- [restorePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.restorePromotions/page.mdx)
- [retrieveCampaign](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.retrieveCampaign/page.mdx)
- [retrievePromotion](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.retrievePromotion/page.mdx)
- [revertUsage](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage/page.mdx)
- [softDeleteCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.softDeleteCampaigns/page.mdx)
- [softDeletePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.softDeletePromotions/page.mdx)
- [updateCampaigns](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.updateCampaigns/page.mdx)
- [updatePromotionRules](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.updatePromotionRules/page.mdx)
- [updatePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.updatePromotions/page.mdx)
www/apps/resources/references/promotion/types/promotion.FindConfigOrder/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: promotionReference
---
import { TypeList } from "docs-ui"
# FindConfigOrder
**FindConfigOrder**: `object`
Temporary type fixing to allow any level of orders until we get to properly clean all the types