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

chore: generate types docs reference manually for 2.3.0 (#11034)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-01-17 18:39:29 +02:00
1 parent 24441e48df
commit 2f7ec55f2e
452 files changed
+67793 -60853
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addRules"/>
www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeRules"/>
www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.retrieve/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/page.mdx
+2 -2
View File
@@ -4,8 +4,8 @@ import { TypeList } from "docs-ui"
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminUpdatePromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCreateCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The campaign's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The campaign's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"`null` \\| `string`","description":"The campaign's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign's identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions start at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions end at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| `object`","description":"The campaign's budget.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"application_method","type":"[AdminUpdateApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"The application method's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"The application method's possible target types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[ApplicationMethodAllocationValues](../../../../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)","description":"The application method's possible allocation values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"apply_to_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules_min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"operator","type":"[PromotionRuleOperatorValues](../../../../../promotiLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminUpdatePromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCreateCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The campaign's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The campaign's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"`null` \\| `string`","description":"The campaign's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign's identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions start at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions end at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| `object`","description":"The campaign's budget.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"application_method","type":"[AdminUpdateApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"The application method's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"The application method's possible target types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[ApplicationMethodAllocationValues](../../../../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)","description":"The application method's possible allocation values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"apply_to_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules_min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optionalLine truncated
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.updateRules/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRules"/>