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

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

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-07-05 09:55:39 +02:00
committed by GitHub
co-authored by kodiakhq
parent 8c30f0a54d
commit ca9ba9e688
128 changed files with 1221 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/generated/files-map.mjs
+184 -4
View File
@@ -4559,6 +4559,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancel/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancel"
},
{
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelClaim/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelClaim"
},
{
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelExchange/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelExchange"
},
{
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelFulfillment/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelFulfillment"
@@ -4567,6 +4575,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelOrderChange/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelOrderChange"
},
{
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn"
},
{
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.completeOrder/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.completeOrder"
@@ -4911,10 +4923,22 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/interfaces/order.CancelOrderChangeDTO/page.mdx",
"pathname": "/references/order/interfaces/order.CancelOrderChangeDTO"
},
{
"filePath": "/www/apps/resources/references/order/interfaces/order.CancelOrderClaimDTO/page.mdx",
"pathname": "/references/order/interfaces/order.CancelOrderClaimDTO"
},
{
"filePath": "/www/apps/resources/references/order/interfaces/order.CancelOrderExchangeDTO/page.mdx",
"pathname": "/references/order/interfaces/order.CancelOrderExchangeDTO"
},
{
"filePath": "/www/apps/resources/references/order/interfaces/order.CancelOrderFulfillmentDTO/page.mdx",
"pathname": "/references/order/interfaces/order.CancelOrderFulfillmentDTO"
},
{
"filePath": "/www/apps/resources/references/order/interfaces/order.CancelOrderReturnDTO/page.mdx",
"pathname": "/references/order/interfaces/order.CancelOrderReturnDTO"
},
{
"filePath": "/www/apps/resources/references/order/interfaces/order.ConfirmOrderChangeDTO/page.mdx",
"pathname": "/references/order/interfaces/order.ConfirmOrderChangeDTO"
@@ -5827,6 +5851,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules"
@@ -5843,6 +5871,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules"
@@ -5879,6 +5911,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules"
@@ -5903,6 +5939,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePriceLists/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePriceLists"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePricePreferences/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePricePreferences"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePrices/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePrices"
@@ -5915,6 +5955,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule"
@@ -5931,6 +5975,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePriceLists/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePriceLists"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePrices/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePrices"
@@ -5943,6 +5991,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules"
@@ -5951,6 +6003,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSets/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSets"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences"
},
{
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPriceSets/page.mdx",
"pathname": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPriceSets"
@@ -5995,6 +6051,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.CreatePriceListRules/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.CreatePriceListRules"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.CreatePricePreferenceDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.CreatePricePreferenceDTO"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.CreatePriceRuleDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.CreatePriceRuleDTO"
@@ -6023,6 +6083,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.FilterablePriceListRuleProps/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.FilterablePriceListRuleProps"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.FilterablePricePreferenceProps/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.FilterablePricePreferenceProps"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.FilterablePriceProps/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.FilterablePriceProps"
@@ -6079,6 +6143,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.PriceListRuleDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.PriceListRuleDTO"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.PricePreferenceDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.PricePreferenceDTO"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.PriceRuleDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.PriceRuleDTO"
@@ -6127,6 +6195,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.UpdatePriceListPricesDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.UpdatePriceListPricesDTO"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.UpdatePricePreferenceDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.UpdatePricePreferenceDTO"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.UpdatePriceRuleDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.UpdatePriceRuleDTO"
@@ -6135,6 +6207,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.UpdatePriceSetDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.UpdatePriceSetDTO"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.UpsertPricePreferenceDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.UpsertPricePreferenceDTO"
},
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.UpsertPriceSetDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.UpsertPriceSetDTO"
@@ -6243,6 +6319,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceListRule/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PriceListRule"
},
{
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PricePreference/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PricePreference"
},
{
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceRule/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PriceRule"
@@ -7476,12 +7556,12 @@ export const filesMap = [
"pathname": "/references/region/types/region.Scalar"
},
{
"filePath": "/www/apps/resources/references/region_models/variables/region_models.Region/page.mdx",
"pathname": "/references/region_models/variables/region_models.Region"
"filePath": "/www/apps/resources/references/region_models/variables/region_models.Country/page.mdx",
"pathname": "/references/region_models/variables/region_models.Country"
},
{
"filePath": "/www/apps/resources/references/region_models/variables/region_models.RegionCountry/page.mdx",
"pathname": "/references/region_models/variables/region_models.RegionCountry"
"filePath": "/www/apps/resources/references/region_models/variables/region_models.Region/page.mdx",
"pathname": "/references/region_models/variables/region_models.Region"
},
{
"filePath": "/www/apps/resources/references/sales_channel/IMessageAggregator/methods/sales_channel.IMessageAggregator.clearMessages/page.mdx",
@@ -8475,6 +8555,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.BatchWorkflowOutput/page.mdx",
"pathname": "/references/types/CommonTypes/types/types.CommonTypes.BatchWorkflowOutput"
},
{
"filePath": "/www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.CamelCase/page.mdx",
"pathname": "/references/types/CommonTypes/types/types.CommonTypes.CamelCase"
},
{
"filePath": "/www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.ContainerLike/page.mdx",
"pathname": "/references/types/CommonTypes/types/types.CommonTypes.ContainerLike"
@@ -8507,6 +8591,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.PluginDetails/page.mdx",
"pathname": "/references/types/CommonTypes/types/types.CommonTypes.PluginDetails"
},
{
"filePath": "/www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.Prettify/page.mdx",
"pathname": "/references/types/CommonTypes/types/types.CommonTypes.Prettify"
},
{
"filePath": "/www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.RawRounding/page.mdx",
"pathname": "/references/types/CommonTypes/types/types.CommonTypes.RawRounding"
@@ -8599,10 +8687,22 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.ExtractEntityRelations/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.ExtractEntityRelations"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.IDmlEntityConfig/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.IDmlEntityConfig"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.Infer/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.Infer"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferEntityType"
@@ -8611,10 +8711,26 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferHasManyFields/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferHasManyFields"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferHasOneFields/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferHasOneFields"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferIndexableProperties"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferManyToManyFields/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferManyToManyFields"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf"
@@ -8779,6 +8895,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionFilters/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionFilters"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCollection/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCollection"
@@ -9107,6 +9227,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionResponse"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCampaign/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCampaign"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCollection/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCollection"
@@ -9879,6 +10003,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.BigNumberValue/page.mdx",
"pathname": "/references/types/types/types.BigNumberValue"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CamelCapitalizer/page.mdx",
"pathname": "/references/types/types/types.CamelCapitalizer"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CamelCaseParser/page.mdx",
"pathname": "/references/types/types/types.CamelCaseParser"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CartLikeWithTotals/page.mdx",
"pathname": "/references/types/types/types.CartLikeWithTotals"
@@ -9919,10 +10051,34 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.FlowRunOptions/page.mdx",
"pathname": "/references/types/types/types.FlowRunOptions"
},
{
"filePath": "/www/apps/resources/references/types/types/types.IncludesSeparator/page.mdx",
"pathname": "/references/types/types/types.IncludesSeparator"
},
{
"filePath": "/www/apps/resources/references/types/types/types.InternalJoinerServiceConfig/page.mdx",
"pathname": "/references/types/types/types.InternalJoinerServiceConfig"
},
{
"filePath": "/www/apps/resources/references/types/types/types.IsCamelCase/page.mdx",
"pathname": "/references/types/types/types.IsCamelCase"
},
{
"filePath": "/www/apps/resources/references/types/types/types.IsOneWord/page.mdx",
"pathname": "/references/types/types/types.IsOneWord"
},
{
"filePath": "/www/apps/resources/references/types/types/types.IsPascalCase/page.mdx",
"pathname": "/references/types/types/types.IsPascalCase"
},
{
"filePath": "/www/apps/resources/references/types/types/types.IsStringLiteral/page.mdx",
"pathname": "/references/types/types/types.IsStringLiteral"
},
{
"filePath": "/www/apps/resources/references/types/types/types.Join/page.mdx",
"pathname": "/references/types/types/types.Join"
},
{
"filePath": "/www/apps/resources/references/types/types/types.JoinerRelationship/page.mdx",
"pathname": "/references/types/types/types.JoinerRelationship"
@@ -9935,6 +10091,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.Order/page.mdx",
"pathname": "/references/types/types/types.Order"
},
{
"filePath": "/www/apps/resources/references/types/types/types.PascalCapitalizer/page.mdx",
"pathname": "/references/types/types/types.PascalCapitalizer"
},
{
"filePath": "/www/apps/resources/references/types/types/types.PascalCaseParser/page.mdx",
"pathname": "/references/types/types/types.PascalCaseParser"
},
{
"filePath": "/www/apps/resources/references/types/types/types.PrevLimit/page.mdx",
"pathname": "/references/types/types/types.PrevLimit"
@@ -9955,6 +10119,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.Scalar/page.mdx",
"pathname": "/references/types/types/types.Scalar"
},
{
"filePath": "/www/apps/resources/references/types/types/types.Separator/page.mdx",
"pathname": "/references/types/types/types.Separator"
},
{
"filePath": "/www/apps/resources/references/types/types/types.SeparatorCaseParser/page.mdx",
"pathname": "/references/types/types/types.SeparatorCaseParser"
},
{
"filePath": "/www/apps/resources/references/types/types/types.SplitAnyCase/page.mdx",
"pathname": "/references/types/types/types.SplitAnyCase"
},
{
"filePath": "/www/apps/resources/references/types/types/types.UpdateProductVariantWorkflowInputDTO/page.mdx",
"pathname": "/references/types/types/types.UpdateProductVariantWorkflowInputDTO"
@@ -9963,6 +10139,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.UpdateProductWorkflowInputDTO/page.mdx",
"pathname": "/references/types/types/types.UpdateProductWorkflowInputDTO"
},
{
"filePath": "/www/apps/resources/references/types/types/types.WordInCamelCase/page.mdx",
"pathname": "/references/types/types/types.WordInCamelCase"
},
{
"filePath": "/www/apps/resources/references/types/types.AdminTypes/page.mdx",
"pathname": "/references/types/types.AdminTypes"
www/apps/resources/generated/sidebar.mjs
+88 -4
View File
@@ -2374,6 +2374,20 @@ export const generatedSidebar = [
"title": "cancel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelClaim",
"title": "cancelClaim",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelExchange",
"title": "cancelExchange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -2388,6 +2402,13 @@ export const generatedSidebar = [
"title": "cancelOrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelReturn",
"title": "cancelReturn",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3603,6 +3624,13 @@ export const generatedSidebar = [
"title": "createPriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/createPricePreferences",
"title": "createPricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3631,6 +3659,13 @@ export const generatedSidebar = [
"title": "deletePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/deletePricePreferences",
"title": "deletePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3694,6 +3729,13 @@ export const generatedSidebar = [
"title": "listPriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listPricePreferences",
"title": "listPricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3736,6 +3778,13 @@ export const generatedSidebar = [
"title": "restorePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/restorePricePreferences",
"title": "restorePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3757,6 +3806,13 @@ export const generatedSidebar = [
"title": "retrievePriceListRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/retrievePricePreference",
"title": "retrievePricePreference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3785,6 +3841,13 @@ export const generatedSidebar = [
"title": "softDeletePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/softDeletePricePreferences",
"title": "softDeletePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3806,6 +3869,13 @@ export const generatedSidebar = [
"title": "updatePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/updatePricePreferences",
"title": "updatePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3820,6 +3890,13 @@ export const generatedSidebar = [
"title": "updatePriceSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/upsertPricePreferences",
"title": "upsertPricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3867,6 +3944,13 @@ export const generatedSidebar = [
"title": "PriceListRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models/PricePreference",
"title": "PricePreference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -4963,15 +5047,15 @@ export const generatedSidebar = [
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/models/Region",
"title": "Region",
"path": "/references/region/models/Country",
"title": "Country",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/models/RegionCountry",
"title": "RegionCountry",
"path": "/references/region/models/Region",
"title": "Region",
"children": []
}
]
www/apps/resources/generated/slug-changes.mjs
+65 -5
View File
@@ -2064,6 +2064,16 @@ export const slugChanges = [
"newSlug": "/references/order/cancel",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancel/page.mdx"
},
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelClaim",
"newSlug": "/references/order/cancelClaim",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelClaim/page.mdx"
},
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelExchange",
"newSlug": "/references/order/cancelExchange",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelExchange/page.mdx"
},
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelFulfillment",
"newSlug": "/references/order/cancelFulfillment",
@@ -2074,6 +2084,11 @@ export const slugChanges = [
"newSlug": "/references/order/cancelOrderChange",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelOrderChange/page.mdx"
},
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn",
"newSlug": "/references/order/cancelReturn",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx"
},
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.completeOrder",
"newSlug": "/references/order/completeOrder",
@@ -2784,6 +2799,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/createPriceLists",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences",
"newSlug": "/references/pricing/createPricePreferences",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules",
"newSlug": "/references/pricing/createPriceRules",
@@ -2804,6 +2824,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/deletePriceLists",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences",
"newSlug": "/references/pricing/deletePricePreferences",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules",
"newSlug": "/references/pricing/deletePriceRules",
@@ -2849,6 +2874,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/listPriceLists",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences",
"newSlug": "/references/pricing/listPricePreferences",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules",
"newSlug": "/references/pricing/listPriceRules",
@@ -2879,6 +2909,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/restorePriceLists",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePriceLists/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePricePreferences",
"newSlug": "/references/pricing/restorePricePreferences",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePricePreferences/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePrices",
"newSlug": "/references/pricing/restorePrices",
@@ -2894,6 +2929,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/retrievePriceListRule",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference",
"newSlug": "/references/pricing/retrievePricePreference",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule",
"newSlug": "/references/pricing/retrievePriceRule",
@@ -2914,6 +2954,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/softDeletePriceLists",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePriceLists/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences",
"newSlug": "/references/pricing/softDeletePricePreferences",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePrices",
"newSlug": "/references/pricing/softDeletePrices",
@@ -2929,6 +2974,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/updatePriceLists",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences",
"newSlug": "/references/pricing/updatePricePreferences",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules",
"newSlug": "/references/pricing/updatePriceRules",
@@ -2939,6 +2989,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/updatePriceSets",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSets/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences",
"newSlug": "/references/pricing/upsertPricePreferences",
"filePath": "/www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences/page.mdx"
},
{
"origSlug": "/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPriceSets",
"newSlug": "/references/pricing/upsertPriceSets",
@@ -2964,6 +3019,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/models/PriceListRule",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceListRule/page.mdx"
},
{
"origSlug": "/references/pricing_models/classes/pricing_models.PricePreference",
"newSlug": "/references/pricing/models/PricePreference",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PricePreference/page.mdx"
},
{
"origSlug": "/references/pricing_models/classes/pricing_models.PriceRule",
"newSlug": "/references/pricing/models/PriceRule",
@@ -3579,16 +3639,16 @@ export const slugChanges = [
"newSlug": "/references/region",
"filePath": "/www/apps/resources/references/region/interfaces/region.IRegionModuleService/page.mdx"
},
{
"origSlug": "/references/region_models/variables/region_models.Country",
"newSlug": "/references/region/models/Country",
"filePath": "/www/apps/resources/references/region_models/variables/region_models.Country/page.mdx"
},
{
"origSlug": "/references/region_models/variables/region_models.Region",
"newSlug": "/references/region/models/Region",
"filePath": "/www/apps/resources/references/region_models/variables/region_models.Region/page.mdx"
},
{
"origSlug": "/references/region_models/variables/region_models.RegionCountry",
"newSlug": "/references/region/models/RegionCountry",
"filePath": "/www/apps/resources/references/region_models/variables/region_models.RegionCountry/page.mdx"
},
{
"origSlug": "/references/sales_channel/ISalesChannelModuleService/methods/sales_channel.ISalesChannelModuleService.createSalesChannels",
"newSlug": "/references/sales-channel/createSalesChannels",
www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx
+5 -7
View File
@@ -283,10 +283,11 @@ Create the file `src/modules/my-auth/index.ts` with the following content:
```ts title="src/modules/my-auth/index.ts"
import MyAuthProviderService from "./service"
import { Module } from "@medusajs/utils"
export default {
export default Module("my-auth", {
service: MyAuthProviderService,
}
})
```
This exports the module's definition, indicating that the `MyAuthProviderService` is the main service of the module.
@@ -311,12 +312,9 @@ module.exports = defineConfig({
providers: [
{
resolve: "./modules/my-auth",
id: "my-auth",
options: {
config: {
"my-auth": {
// provider options...
},
},
// provider options...
},
},
],
www/apps/resources/references/currency_models/variables/currency_models.Currency/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Currency . This belongs to the Currency Module.
<TypeList types={[{"name":"code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Currency"/>
<TypeList types={[{"name":"code","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Currency"/>
www/apps/resources/references/dml/Model_Methods/methods/dml.Model_Methods.indexes/page.mdx
+1 -1
View File
@@ -78,4 +78,4 @@ In this example, the index is created when the value of `age` doesn't equal `30`
## Parameters
<TypeList types={[{"name":"indexes","type":"[EntityIndex](../../../../types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx)&#60;Schema, string \\| [QueryCondition](../../../../types/DmlTypes/types/types.DmlTypes.QueryCondition/page.mdx)&#60;Schema&#62;&#62;[]","description":"The index's configuration.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"on","type":"[InferIndexableProperties](../../../../types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx)&#60;[IDmlEntity](../../../../types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;TSchema&#62;&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"TWhere","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="indexes"/>
<TypeList types={[{"name":"indexes","type":"[EntityIndex](../../../../types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx)&#60;Schema, string \\| [QueryCondition](../../../../types/DmlTypes/types/types.DmlTypes.QueryCondition/page.mdx)&#60;Schema&#62;&#62;[]","description":"The index's configuration.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"on","type":"[InferIndexableProperties](../../../../types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx)&#60;[IDmlEntity](../../../../types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;TSchema, any&#62;&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"TWhere","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="indexes"/>
www/apps/resources/references/dml/Relationship_Methods/methods/dml.Relationship_Methods.belongsTo/page.mdx
+1 -1
View File
@@ -28,4 +28,4 @@ const Product = model.define("product", {
## Parameters
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RelationshipOptions](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined\nin the other data model. This is only required\nby the `belongsTo` relationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="belongsTo"/>
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RelationshipOptions](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="belongsTo"/>
www/apps/resources/references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasMany/page.mdx
+1 -1
View File
@@ -30,4 +30,4 @@ const Store = model.define("store", {
## Parameters
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RelationshipOptions](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined\nin the other data model. This is only required\nby the `belongsTo` relationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="hasMany"/>
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RelationshipOptions](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="hasMany"/>
www/apps/resources/references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx
+1 -1
View File
@@ -33,4 +33,4 @@ const User = model.define("user", {
## Parameters
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RelationshipOptions](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined\nin the other data model. This is only required\nby the `belongsTo` relationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="hasOne"/>
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RelationshipOptions](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="hasOne"/>
www/apps/resources/references/dml/Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx
+1 -1
View File
@@ -35,4 +35,4 @@ const Product = model.define("product", {
## Parameters
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ManyToManyOptions](../../../entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined\nin the other data model. This is only required\nby the `belongsTo` relationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotTable","type":"`string`","description":"The name of the pivot table\ncreated in the database for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotEntity","type":"() => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any&#62;","description":"A function that returns the data model \nrepresenting the pivot table created in the\ndatabase for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="manyToMany"/>
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ManyToManyOptions](../../../entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotTable","type":"`string`","description":"The name of the pivot table\ncreated in the database for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotEntity","type":"() => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any&#62;","description":"A function that returns the data model \nrepresenting the pivot table created in the\ndatabase for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="manyToMany"/>
www/apps/resources/references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx
+3 -3
View File
@@ -8,9 +8,9 @@ import { TypeList } from "docs-ui"
`Optional` **mappedBy**: `string`
The name of the relationship as defined
in the other data model. This is only required
by the `belongsTo` relationship method.
The name of the relationship as defined in the other
data model. This is only required by the `belongsTo`
relationship method.
___
www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx
+5 -7
View File
@@ -173,10 +173,11 @@ Create the file `src/modules/my-file/index.ts` with the following content:
```ts title="src/modules/my-file/index.ts"
import MyFileProviderService from "./service"
import { Module } from "@medusajs/utils"
export default {
export default Module("my-file", {
service: MyFileProviderService,
}
})
```
This exports the module's definition, indicating that the `MyFileProviderService` is the main service of the module.
@@ -207,12 +208,9 @@ module.exports = defineConfig({
providers: [
{
resolve: "./modules/my-file",
id: "my-file",
options: {
config: {
"my-file": {
// provider options...
},
},
// provider options...
},
},
],
www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx
+5 -7
View File
@@ -50,10 +50,11 @@ Create the file `src/modules/my-fulfillment/index.ts` with the following content
```ts title="src/modules/my-fulfillment/index.ts"
import MyFulfillmentProviderService from "./service"
import { Module } from "@medusajs/utils"
export default {
export default Module("my-fulfillment", {
service: MyFulfillmentProviderService,
}
})
```
This exports the module's definition, indicating that the `MyFulfillmentProviderService` is the main service of the module.
@@ -78,12 +79,9 @@ module.exports = defineConfig({
providers: [
{
resolve: "./modules/my-fulfillment",
id: "my-fulfillment",
options: {
config: {
"my-fulfillment": {
// provider options...
},
},
// provider options...
},
},
],
www/apps/resources/references/modules/order/page.mdx
+3
View File
@@ -76,8 +76,11 @@ import { TypeList } from "docs-ui"
- [CancelOrderFulfillmentDTO](../../order/interfaces/order.CancelOrderFulfillmentDTO/page.mdx)
- [RegisterOrderShipmentDTO](../../order/interfaces/order.RegisterOrderShipmentDTO/page.mdx)
- [CreateOrderReturnDTO](../../order/interfaces/order.CreateOrderReturnDTO/page.mdx)
- [CancelOrderReturnDTO](../../order/interfaces/order.CancelOrderReturnDTO/page.mdx)
- [CreateOrderClaimDTO](../../order/interfaces/order.CreateOrderClaimDTO/page.mdx)
- [CancelOrderClaimDTO](../../order/interfaces/order.CancelOrderClaimDTO/page.mdx)
- [CreateOrderExchangeDTO](../../order/interfaces/order.CreateOrderExchangeDTO/page.mdx)
- [CancelOrderExchangeDTO](../../order/interfaces/order.CancelOrderExchangeDTO/page.mdx)
- [ReceiveOrderReturnDTO](../../order/interfaces/order.ReceiveOrderReturnDTO/page.mdx)
- [CreateOrderReturnReasonDTO](../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)
- [UpdateOrderReturnReasonDTO](../../order/interfaces/order.UpdateOrderReturnReasonDTO/page.mdx)
www/apps/resources/references/modules/order_models/page.mdx
+1 -2
View File
@@ -46,10 +46,9 @@ erDiagram
OrderShippingMethod }|--|{ Return : return
OrderShippingMethod }|--|{ ShippingMethod : shipping_method
Return }|--|{ Order : order
Return ||--|| OrderItem : items
Return ||--|| ReturnItem : items
Return ||--|| Transaction : transactions
ReturnItem }|--|{ ReturnReason : reason
ReturnItem }|--|{ Return : return
ReturnItem }|--|{ LineItem : item
ReturnReason }|--|{ ReturnReason : parent_return_reason
ShippingMethod ||--|| ShippingMethodTaxLine : tax_lines
www/apps/resources/references/modules/pricing/page.mdx
+5
View File
@@ -29,6 +29,11 @@ import { TypeList } from "docs-ui"
- [UpdatePriceListPricesDTO](../../pricing/interfaces/pricing.UpdatePriceListPricesDTO/page.mdx)
- [SetPriceListRulesDTO](../../pricing/interfaces/pricing.SetPriceListRulesDTO/page.mdx)
- [RemovePriceListRulesDTO](../../pricing/interfaces/pricing.RemovePriceListRulesDTO/page.mdx)
- [PricePreferenceDTO](../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)
- [UpsertPricePreferenceDTO](../../pricing/interfaces/pricing.UpsertPricePreferenceDTO/page.mdx)
- [UpdatePricePreferenceDTO](../../pricing/interfaces/pricing.UpdatePricePreferenceDTO/page.mdx)
- [CreatePricePreferenceDTO](../../pricing/interfaces/pricing.CreatePricePreferenceDTO/page.mdx)
- [FilterablePricePreferenceProps](../../pricing/interfaces/pricing.FilterablePricePreferenceProps/page.mdx)
- [PriceRuleDTO](../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)
- [CreatePriceRuleDTO](../../pricing/interfaces/pricing.CreatePriceRuleDTO/page.mdx)
- [UpdatePriceRuleDTO](../../pricing/interfaces/pricing.UpdatePriceRuleDTO/page.mdx)
www/apps/resources/references/modules/pricing_models/page.mdx
+1
View File
@@ -24,6 +24,7 @@ erDiagram
- [PriceListRule](../../pricing_models/classes/pricing_models.PriceListRule/page.mdx)
- [PriceList](../../pricing_models/classes/pricing_models.PriceList/page.mdx)
- [PricePreference](../../pricing_models/classes/pricing_models.PricePreference/page.mdx)
- [PriceRule](../../pricing_models/classes/pricing_models.PriceRule/page.mdx)
- [PriceSet](../../pricing_models/classes/pricing_models.PriceSet/page.mdx)
- [Price](../../pricing_models/classes/pricing_models.Price/page.mdx)
www/apps/resources/references/modules/region_models/page.mdx
+2 -2
View File
@@ -13,11 +13,11 @@ This documentation provides a reference to the data models in the Region Module
```mermaid
erDiagram
Region ||--|| RegionCountry : countries
Region ||--|| Country : countries
```
## Data Models
- [RegionCountry](../../region_models/variables/region_models.RegionCountry/page.mdx)
- [Country](../../region_models/variables/region_models.Country/page.mdx)
- [Region](../../region_models/variables/region_models.Region/page.mdx)
www/apps/resources/references/modules/types/page.mdx
+14
View File
@@ -73,6 +73,20 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [AddressDTO](../../types/types/types.AddressDTO/page.mdx)
- [IsStringLiteral](../../types/types/types.IsStringLiteral/page.mdx)
- [WordInCamelCase](../../types/types/types.WordInCamelCase/page.mdx)
- [Separator](../../types/types/types.Separator/page.mdx)
- [IncludesSeparator](../../types/types/types.IncludesSeparator/page.mdx)
- [IsOneWord](../../types/types/types.IsOneWord/page.mdx)
- [IsCamelCase](../../types/types/types.IsCamelCase/page.mdx)
- [IsPascalCase](../../types/types/types.IsPascalCase/page.mdx)
- [SeparatorCaseParser](../../types/types/types.SeparatorCaseParser/page.mdx)
- [CamelCaseParser](../../types/types/types.CamelCaseParser/page.mdx)
- [PascalCaseParser](../../types/types/types.PascalCaseParser/page.mdx)
- [SplitAnyCase](../../types/types/types.SplitAnyCase/page.mdx)
- [PascalCapitalizer](../../types/types/types.PascalCapitalizer/page.mdx)
- [CamelCapitalizer](../../types/types/types.CamelCapitalizer/page.mdx)
- [Join](../../types/types/types.Join/page.mdx)
- [EntityClassName](../../types/types/types.EntityClassName/page.mdx)
- [EntityValues](../../types/types/types.EntityValues/page.mdx)
- [Dictionary](../../types/types/types.Dictionary/page.mdx)
www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx
+6 -8
View File
@@ -120,10 +120,11 @@ Create the file `src/modules/my-notification/index.ts` with the following conten
```ts title="src/modules/my-notification/index.ts"
import MyNotificationProviderService from "./service"
import { Module } from "@medusajs/utils"
export default {
export default Module("my-notification", {
service: MyNotificationProviderService,
}
})
```
This exports the module's definition, indicating that the `MyNotificationProviderService` is the main service of the module.
@@ -154,13 +155,10 @@ module.exports = defineConfig({
providers: [
{
resolve: "./modules/my-notification",
id: "my-notification",
options: {
config: {
"my-notification": {
channels: ["email"],
// provider options...
},
},
channels: ["email"],
// provider options...
},
},
],
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelClaim/page.mdx
+19
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelExchange/page.mdx
+19
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx
+19
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.createClaim/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.createExchange/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.createOrders/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.createReturn/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.createShippingMethods/page.mdx
+3 -3
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/interfaces/order.CancelOrderClaimDTO/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# CancelOrderClaimDTO
<TypeList types={[{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CancelOrderClaimDTO"/>
www/apps/resources/references/order/interfaces/order.CancelOrderExchangeDTO/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# CancelOrderExchangeDTO
<TypeList types={[{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CancelOrderExchangeDTO"/>
www/apps/resources/references/order/interfaces/order.CancelOrderReturnDTO/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# CancelOrderReturnDTO
<TypeList types={[{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CancelOrderReturnDTO"/>
www/apps/resources/references/order/interfaces/order.CreateOrderClaimDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/interfaces/order.CreateOrderDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/interfaces/order.CreateOrderExchangeDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/interfaces/order.CreateOrderReturnDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order/interfaces/order.CreateOrderShippingMethodDTO/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
SHIPPING METHODS START
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"version","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateOrderTaxLineDTO](../order.CreateOrderTaxLineDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateOrderAdjustmentDTO](../order.CreateOrderAdjustmentDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateOrderShippingMethodDTO"/>
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateOrderTaxLineDTO](../order.CreateOrderTaxLineDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateOrderAdjustmentDTO](../order.CreateOrderAdjustmentDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateOrderShippingMethodDTO"/>
www/apps/resources/references/order/interfaces/order.IOrderModuleService/page.mdx
+3
View File
@@ -99,6 +99,9 @@ This section of the documentation provides a reference to the `IOrderModuleServi
- [cancelFulfillment](../../IOrderModuleService/methods/order.IOrderModuleService.cancelFulfillment/page.mdx)
- [registerShipment](../../IOrderModuleService/methods/order.IOrderModuleService.registerShipment/page.mdx)
- [createReturn](../../IOrderModuleService/methods/order.IOrderModuleService.createReturn/page.mdx)
- [cancelReturn](../../IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx)
- [receiveReturn](../../IOrderModuleService/methods/order.IOrderModuleService.receiveReturn/page.mdx)
- [createClaim](../../IOrderModuleService/methods/order.IOrderModuleService.createClaim/page.mdx)
- [cancelClaim](../../IOrderModuleService/methods/order.IOrderModuleService.cancelClaim/page.mdx)
- [createExchange](../../IOrderModuleService/methods/order.IOrderModuleService.createExchange/page.mdx)
- [cancelExchange](../../IOrderModuleService/methods/order.IOrderModuleService.cancelExchange/page.mdx)
www/apps/resources/references/order/types/order.ChangeActionType/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# ChangeActionType
**ChangeActionType**: `"CANCEL"` \| `"CANCEL_RETURN"` \| `"FULFILL_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"`
**ChangeActionType**: `"CANCEL"` \| `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"`
www/apps/resources/references/order_models/classes/order_models.ClaimItem/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.ExchangeItem/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.Order/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.OrderChange/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.OrderChangeAction/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.OrderClaim/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.OrderExchange/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.OrderShippingMethod/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.Return/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.ReturnItem/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/order_models/classes/order_models.Transaction/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences/page.mdx
+57
View File
@@ -0,0 +1,57 @@
---
displayed_sidebar: pricingReference
slug: /references/pricing/createPricePreferences
sidebar_label: createPricePreferences
---
import { TypeList } from "docs-ui"
# createPricePreferences - Pricing Module Reference
This documentation provides a reference to the `createPricePreferences` method. This belongs to the Pricing Module.
## createPricePreferences(data, sharedContext?): Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)&#62;
This method is used to create a new price preference.
### Example
To create a price preference with rule:
```ts
const pricePreference = await pricingModuleService.createPricePreferences({
attribute: 'region_id',
value: 'DE',
is_tax_inclusive: true
})
```
### Parameters
<TypeList types={[{"name":"data","type":"[CreatePricePreferenceDTO](../../../interfaces/pricing.CreatePricePreferenceDTO/page.mdx)","description":"The attributes of the price preference to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/pricing.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/pricing.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":[]}]}]} sectionTitle="createPricePreferences"/>
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created price preference.","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createPricePreferences"/>
## createPricePreferences(data, sharedContext?): Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)[]&#62;
This method is used to create multiple price preferences.
### Example
```ts
const pricePreferences = await pricingModuleService.createPricePreferences([{
attribute: 'region_id',
value: 'DE',
is_tax_inclusive: true
}])
```
### Parameters
<TypeList types={[{"name":"data","type":"[CreatePricePreferenceDTO](../../../interfaces/pricing.CreatePricePreferenceDTO/page.mdx)[]","description":"The price preferences to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/pricing.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/pricing.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":[]}]}]} sectionTitle="createPricePreferences"/>
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of created price preferences.","expandable":false,"children":[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"`object`","description":"A price preference's data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createPricePreferences"/>
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSets/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences/page.mdx
+27
View File
@@ -0,0 +1,27 @@
---
displayed_sidebar: pricingReference
slug: /references/pricing/deletePricePreferences
sidebar_label: deletePricePreferences
---
import { TypeList } from "docs-ui"
# deletePricePreferences - Pricing Module Reference
This documentation provides a reference to the `deletePricePreferences` method. This belongs to the Pricing Module.
This method deletes price preferences by their IDs.
## Example
```ts
await pricingModuleService.deletePricePreferences(["prpref_123", "prpref_321"])
```
## Parameters
<TypeList types={[{"name":"ids","type":"`string`[]","description":"The IDs of the price preferences to delete.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/pricing.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/pricing.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":[]}]}]} sectionTitle="deletePricePreferences"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"Resolves when the price preferences are successfully deleted.","expandable":false,"children":[]}]} sectionTitle="deletePricePreferences"/>
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSets/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences/page.mdx
+47
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSets/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.restorePricePreferences/page.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: pricingReference
slug: /references/pricing/restorePricePreferences
sidebar_label: restorePricePreferences
---
import { TypeList } from "docs-ui"
# restorePricePreferences - Pricing Module Reference
This documentation provides a reference to the `restorePricePreferences` method. This belongs to the Pricing Module.
This method restores soft deleted price preferences by their IDs.
## Example
```ts
await pricingModuleService.restorePricePreferences([
"prpref_123",
"prpref_321",
])
```
## Parameters
<TypeList types={[{"name":"pricePreferenceIds","type":"`string`[]","description":"The IDs of the price preferences.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[RestoreReturn](../../../interfaces/pricing.RestoreReturn/page.mdx)&#60;TReturnableLinkableKeys&#62;","description":"Configurations determining which relations to restore along with each of the price preferences.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"returnLinkableKeys","type":"TReturnableLinkableKeys[]","description":"An array of strings, each being the ID attribute names of the entity's relations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/pricing.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/pricing.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":[]}]}]} sectionTitle="restorePricePreferences"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void \\| Record&#60;string, string[]&#62;&#62;","optional":false,"defaultValue":"","description":"An object that includes the IDs of related records that were restored.\nThe object's keys are the ID attribute names of the price preferences entity's relations,\nand its value is an array of strings, each being the ID of the record associated with the price preferences through this relation.\n\nIf there are no related records restored, the promise resolves to `void`.","expandable":false,"children":[{"name":"void \\| Record&#60;string, string[]&#62;","type":"`void` \\| `Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="restorePricePreferences"/>
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference/page.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: pricingReference
slug: /references/pricing/retrievePricePreference
sidebar_label: retrievePricePreference
---
import { TypeList } from "docs-ui"
# retrievePricePreference - Pricing Module Reference
This documentation provides a reference to the `retrievePricePreference` method. This belongs to the Pricing Module.
This method is used to retrieve a price preference by its ID.
## Example
A simple example that retrieves a price preference by its ID:
```ts
const pricePreference =
await pricingModuleService.retrievePricePreference("prpref_123")
```
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the price preference to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/pricing.FindConfig/page.mdx)&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)&#62;","description":"The configurations determining how the price preference is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a price preference.","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":"`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/pricing.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/pricing.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":[]}]}]} sectionTitle="retrievePricePreference"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved price preference.","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="retrievePricePreference"/>
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSet/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences/page.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: pricingReference
slug: /references/pricing/softDeletePricePreferences
sidebar_label: softDeletePricePreferences
---
import { TypeList } from "docs-ui"
# softDeletePricePreferences - Pricing Module Reference
This documentation provides a reference to the `softDeletePricePreferences` method. This belongs to the Pricing Module.
This method soft deletes price preferences by their IDs.
## Example
```ts
await pricingModuleService.softDeletePricePreferences([
"prpref_123",
"prpref_321",
])
```
## Parameters
<TypeList types={[{"name":"pricePreferenceIds","type":"`string`[]","description":"The IDs of the price preferences.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[SoftDeleteReturn](../../../interfaces/pricing.SoftDeleteReturn/page.mdx)&#60;TReturnableLinkableKeys&#62;","description":"An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"returnLinkableKeys","type":"TReturnableLinkableKeys[]","description":"An array of strings, each being the ID attribute names of the entity's relations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/pricing.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/pricing.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":[]}]}]} sectionTitle="softDeletePricePreferences"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void \\| Record&#60;string, string[]&#62;&#62;","optional":false,"defaultValue":"","description":"An object that includes the IDs of related records that were also soft deleted.\nThe object's keys are the ID attribute names of the price preference entity's relations, and its value is an array of strings, each being the ID of a record associated.\n\nIf there are no related records, the promise resolves to `void`.","expandable":false,"children":[{"name":"void \\| Record&#60;string, string[]&#62;","type":"`void` \\| `Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="softDeletePricePreferences"/>
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences/page.mdx
+59
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSets/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences/page.mdx
+61
View File
@@ -0,0 +1,61 @@
---
displayed_sidebar: pricingReference
slug: /references/pricing/upsertPricePreferences
sidebar_label: upsertPricePreferences
---
import { TypeList } from "docs-ui"
# upsertPricePreferences - Pricing Module Reference
This documentation provides a reference to the `upsertPricePreferences` method. This belongs to the Pricing Module.
## upsertPricePreferences(data, sharedContext?): Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)[]&#62;
This method updates existing price preferences, or creates new ones if they don't exist.
### Example
```ts
const pricePreferences = await pricingModuleService.upsertPricePreferences([
{
id: "prpref_123",
attribute: 'region_id',
value: 'DE',
is_tax_inclusive: true
},
])
```
### Parameters
<TypeList types={[{"name":"data","type":"[UpsertPricePreferenceDTO](../../../interfaces/pricing.UpsertPricePreferenceDTO/page.mdx)[]","description":"The attributes to update or create for each price preference.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/pricing.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/pricing.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":[]}]}]} sectionTitle="upsertPricePreferences"/>
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated and created price preferences.","expandable":false,"children":[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"`object`","description":"A price preference's data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="upsertPricePreferences"/>
## upsertPricePreferences(data, sharedContext?): Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)&#62;
This method updates the price preference if it exists, or creates a new ones if it doesn't.
### Example
```ts
const pricePreference = await pricingModuleService.upsertPricePreferences(
{
id: "prpref_123",
attribute: 'region_id',
value: 'DE',
is_tax_inclusive: true
}
)
```
### Parameters
<TypeList types={[{"name":"data","type":"[UpsertPricePreferenceDTO](../../../interfaces/pricing.UpsertPricePreferenceDTO/page.mdx)","description":"The attributes to update or create for the new price preference.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/pricing.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/pricing.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":[]}]}]} sectionTitle="upsertPricePreferences"/>
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated or created price preference.","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="upsertPricePreferences"/>
www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.upsertPriceSets/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/interfaces/pricing.CalculatedPriceSet/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The calculated price for a specific price set and context.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_price_list","type":"`boolean`","description":"Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override,\nthe original price will be the same as the calculated price. In that case, the value of this property is `true`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"`object`","description":"The details of the calculated price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`null` \\| `string`","description":"The ID of the price selected as the calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_type","type":"`null` \\| `string`","description":"The type of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `min_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `max_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_price","type":"`object`","description":"The details of the original price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`null` \\| `string`","description":"The ID of the price selected as the original price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_type","type":"`null` \\| `string`","description":"The type of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `min_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `max_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CalculatedPriceSet"/>
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"Whether the calculated price is tax inclusive or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_price_list","type":"`boolean`","description":"Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override,\nthe original price will be the same as the calculated price. In that case, the value of this property is `true`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_tax_inclusive","type":"`boolean`","description":"Whether the original price is tax inclusive or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"`object`","description":"The details of the calculated price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`null` \\| `string`","description":"The ID of the price selected as the calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_type","type":"`null` \\| `string`","description":"The type of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `min_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `max_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_price","type":"`object`","description":"The details of the original price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`null` \\| `string`","description":"The ID of the price selected as the original price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_type","type":"`null` \\| `string`","description":"The type of the associated price list, if any.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `min_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberValue](../../types/pricing.BigNumberValue/page.mdx)","description":"The `max_quantity` field defined on a price.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CalculatedPriceSet"/>
www/apps/resources/references/pricing/interfaces/pricing.CreatePricePreferenceDTO/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# CreatePricePreferenceDTO
<TypeList types={[{"name":"attribute","type":"`string`","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreatePricePreferenceDTO"/>
www/apps/resources/references/pricing/interfaces/pricing.FilterablePricePreferenceProps/page.mdx
+11
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/interfaces/pricing.IPricingModuleService/page.mdx
+8
View File
@@ -49,3 +49,11 @@ The main service interface for the Pricing Module.
- [setPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules/page.mdx)
- [removePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules/page.mdx)
- [removePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.removePrices/page.mdx)
- [retrievePricePreference](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference/page.mdx)
- [listPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences/page.mdx)
- [createPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences/page.mdx)
- [upsertPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences/page.mdx)
- [updatePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences/page.mdx)
- [softDeletePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences/page.mdx)
- [restorePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.restorePricePreferences/page.mdx)
- [deletePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences/page.mdx)
www/apps/resources/references/pricing/interfaces/pricing.PriceDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/interfaces/pricing.PricePreferenceDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# PricePreferenceDTO
A price preference's data.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="PricePreferenceDTO"/>
www/apps/resources/references/pricing/interfaces/pricing.PriceRuleDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/interfaces/pricing.PriceSetDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/pricing/interfaces/pricing.UpdatePricePreferenceDTO/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# UpdatePricePreferenceDTO
<TypeList types={[{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdatePricePreferenceDTO"/>
www/apps/resources/references/pricing/interfaces/pricing.UpsertPricePreferenceDTO/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# UpsertPricePreferenceDTO
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpsertPricePreferenceDTO"/>
www/apps/resources/references/pricing_models/classes/pricing_models.PricePreference/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PricePreference
sidebar_label: PricePreference
---
import { TypeList } from "docs-ui"
# PricePreference - Pricing Module Data Models Reference
This documentation provides a reference to the PricePreference . This belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} sectionTitle="PricePreference"/>
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.createCampaigns/page.mdx
+2 -2
View File
@@ -33,7 +33,7 @@ const campaign = await promotionModuleService.createCampaigns(
### Parameters
<TypeList types={[{"name":"data","type":"[CreateCampaignDTO](../../../interfaces/promotion.CreateCampaignDTO/page.mdx)","description":"The campaign to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CreateCampaignBudgetDTO](../../../interfaces/promotion.CreateCampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"[CampaignBudgetTypeValues](../../../types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"The type of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number`","description":"The limit of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`number`","description":"How much is used of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency of the campaign.","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":[]}]}]} sectionTitle="createCampaigns"/>
<TypeList types={[{"name":"data","type":"[CreateCampaignDTO](../../../interfaces/promotion.CreateCampaignDTO/page.mdx)","description":"The campaign to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CreateCampaignBudgetDTO](../../../interfaces/promotion.CreateCampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"[CampaignBudgetTypeValues](../../../types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"The type of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number`","description":"The limit of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`number`","description":"How much is used of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency of the campaign.","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":[]}]}]} sectionTitle="createCampaigns"/>
### Returns
@@ -63,7 +63,7 @@ const campaigns =
### Parameters
<TypeList types={[{"name":"data","type":"[CreateCampaignDTO](../../../interfaces/promotion.CreateCampaignDTO/page.mdx)[]","description":"The campaigns to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CreateCampaignBudgetDTO](../../../interfaces/promotion.CreateCampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"[CampaignBudgetTypeValues](../../../types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"The type of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number`","description":"The limit of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`number`","description":"How much is used of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency of the campaign.","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":[]}]}]} sectionTitle="createCampaigns"/>
<TypeList types={[{"name":"data","type":"[CreateCampaignDTO](../../../interfaces/promotion.CreateCampaignDTO/page.mdx)[]","description":"The campaigns to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CreateCampaignBudgetDTO](../../../interfaces/promotion.CreateCampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"[CampaignBudgetTypeValues](../../../types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"The type of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number`","description":"The limit of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`number`","description":"How much is used of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency of the campaign.","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":[]}]}]} sectionTitle="createCampaigns"/>
### Returns
www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.createPromotions/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/promotion/interfaces/promotion.CreateCampaignDTO/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The campaign to be created.
<TypeList types={[{"name":"name","type":"`string`","description":"The name of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CreateCampaignBudgetDTO](../promotion.CreateCampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"[CampaignBudgetTypeValues](../../types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"The type of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number`","description":"The limit of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`number`","description":"How much is used of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateCampaignDTO"/>
<TypeList types={[{"name":"name","type":"`string`","description":"The name of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CreateCampaignBudgetDTO](../promotion.CreateCampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"[CampaignBudgetTypeValues](../../types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"The type of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number`","description":"The limit of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`number`","description":"How much is used of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateCampaignDTO"/>
www/apps/resources/references/promotion/interfaces/promotion.CreatePromotionDTO/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/region_models/variables/region_models.Country/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: regionModelReference
slug: /references/region/models/Country
sidebar_label: Country
---
import { TypeList } from "docs-ui"
# Country - Region Module Data Models Reference
This documentation provides a reference to the Country . This belongs to the Region Module.
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](../region_models.Region/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](../region_models.Region/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Country"/>
www/apps/resources/references/region_models/variables/region_models.Region/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Region . This belongs to the Region Module.
<TypeList types={[{"name":"id","type":"`IdProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[RegionCountry](../region_models.RegionCountry/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`IdProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[RegionCountry](../region_models.RegionCountry/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Region"/>
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](../region_models.Country/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](../region_models.Country/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Region"/>
www/apps/resources/references/region_models/variables/region_models.RegionCountry/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: regionModelReference
slug: /references/region/models/RegionCountry
sidebar_label: RegionCountry
---
import { TypeList } from "docs-ui"
# RegionCountry - Region Module Data Models Reference
This documentation provides a reference to the RegionCountry . This belongs to the Region Module.
<TypeList types={[{"name":"iso_2","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](../region_models.Region/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`IdProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[RegionCountry](page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](../region_models.Region/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RegionCountry"/>
www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.CamelCase/page.mdx
+9
View File
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CamelCase
**CamelCase**: [IsStringLiteral](../../../types/types.IsStringLiteral/page.mdx)&#60;Type&#62; extends `true` ? [Join](../../../types/types.Join/page.mdx)&#60;[CamelCapitalizer](../../../types/types.CamelCapitalizer/page.mdx)&#60;[SplitAnyCase](../../../types/types.SplitAnyCase/page.mdx)&#60;Type&#62;&#62;&#62; : Type
## Type Parameters
<TypeList types={[{"name":"Type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CamelCase"/>
www/apps/resources/references/types/CommonTypes/types/types.CommonTypes.Prettify/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# Prettify
**Prettify**: &#123; [K in keyof T]: T[K] &#125; & `object`
Prettify complex types to a flat object structure
## Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Prettify"/>
www/apps/resources/references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx
+4 -2
View File
@@ -2,10 +2,12 @@ import { TypeList } from "docs-ui"
# IDmlEntity
Representation of a DML entity
## Type parameters
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../../types/types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../../types/types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="IDmlEntity"/>
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../../types/types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../../types/types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"Config","type":"[IDmlEntityConfig](../../types/types.DmlTypes.IDmlEntityConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"tableName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="IDmlEntity"/>
## Properties
<TypeList types={[{"name":"[IsDmlEntity]","type":"`true`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="IDmlEntity"/>
<TypeList types={[{"name":"[IsDmlEntity]","type":"`true`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)&#60;Config&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="IDmlEntity"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.DMLSchema/page.mdx
+4
View File
@@ -3,3 +3,7 @@ import { TypeList } from "docs-ui"
# DMLSchema
**DMLSchema**: `Record<string, [PropertyType](../types.DmlTypes.PropertyType/page.mdx)&#60;any&#62; \| [RelationshipType](../types.DmlTypes.RelationshipType/page.mdx)&#60;any&#62;>`
Representation of DML schema. It must be a key-value pair
with string based keys and properties/relationships
as the value.
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
## Properties
<TypeList types={[{"name":"on","type":"[InferIndexableProperties](../types.DmlTypes.InferIndexableProperties/page.mdx)&#60;[IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;TSchema&#62;&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"TWhere","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="EntityIndex"/>
<TypeList types={[{"name":"on","type":"[InferIndexableProperties](../types.DmlTypes.InferIndexableProperties/page.mdx)&#60;[IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;TSchema, any&#62;&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"TWhere","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="EntityIndex"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.IDmlEntityConfig/page.mdx
+5
View File
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# IDmlEntityConfig
**IDmlEntityConfig**: `string` \| `object`
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.Infer/page.mdx
+1 -1
View File
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
# Infer
**Infer**: T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer Schema&#62; ? [EntityConstructor](../../interfaces/types.DmlTypes.EntityConstructor/page.mdx)&#60;&#123; [K in keyof Schema]: Schema[K]["$dataType"] extends Function ? Infer&#60;R&#62; : Schema[K]["$dataType"] extends Function \| null ? Infer&#60;R&#62; \| null : Schema[K]["$dataType"] &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;T&#62;&#62; : `never`
**Infer**: T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer Schema, any&#62; ? [EntityConstructor](../../interfaces/types.DmlTypes.EntityConstructor/page.mdx)&#60;[InferSchemaFields](../types.DmlTypes.InferSchemaFields/page.mdx)&#60;Schema&#62;&#62; : `never`
Helper to infer the schema type of a DmlEntity
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# InferBelongsToFields
**InferBelongsToFields**: Relation extends () => [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer R, any&#62; ? [InferSchemaFields](../types.DmlTypes.InferSchemaFields/page.mdx)&#60;R&#62; : Relation extends () => [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer R, any&#62; \| `null` ? [InferSchemaFields](../types.DmlTypes.InferSchemaFields/page.mdx)&#60;R&#62; \| `null` : `never`
Infer fields for a belongsTo relationship
## Type Parameters
<TypeList types={[{"name":"Relation","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InferBelongsToFields"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx
+9
View File
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# InferDmlEntityNameFromConfig
**InferDmlEntityNameFromConfig**: TConfig extends `string` ? [CamelCase](../../../CommonTypes/types/types.CommonTypes.CamelCase/page.mdx)&#60;TConfig&#62; : TConfig extends `object` ? [CamelCase](../../../CommonTypes/types/types.CommonTypes.CamelCase/page.mdx)&#60;TConfig["name"]&#62; : TConfig extends `object` ? [CamelCase](../../../CommonTypes/types/types.CommonTypes.CamelCase/page.mdx)&#60;TConfig["tableName"]&#62; : `never`
## Type Parameters
<TypeList types={[{"name":"TConfig","type":"[IDmlEntityConfig](../types.DmlTypes.IDmlEntityConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"tableName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="InferDmlEntityNameFromConfig"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx
+2 -2
View File
@@ -2,10 +2,10 @@ import { TypeList } from "docs-ui"
# InferEntityType
**InferEntityType**: T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;any&#62; ? [InferTypeOf](../types.DmlTypes.InferTypeOf/page.mdx)&#60;T&#62; : T
**InferEntityType**: T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;any, any&#62; ? [InferTypeOf](../types.DmlTypes.InferTypeOf/page.mdx)&#60;T&#62; : T
Used in the module sdk internal service to infer propert entity typings from DML
## Type Parameters
<TypeList types={[{"name":"T","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InferEntityType"/>
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InferEntityType"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx
+4 -3
View File
@@ -2,10 +2,11 @@ import { TypeList } from "docs-ui"
# InferForeignKeys
**InferForeignKeys**: T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer Schema&#62; ? &#123; [K in keyof Schema as Schema[K] extends Object ? Type extends RelationshipTypes ? \`$&#123;K & string&#125;\_id\` : K : K]: Schema[K] extends Object ? Type extends RelationshipTypes ? string : Schema[K] : Schema[K] &#125; : `never`
**InferForeignKeys**: &#123; [K in keyof Schema as Schema[K] extends Object ? Type extends RelationshipTypes ? \`$&#123;K & string&#125;\_id\` : never : never]: Schema[K] extends Object ? Type extends RelationshipTypes ? string : never : never &#125;
From a IDmlEntity, infer the foreign keys name and type for belongsTo relation meaning hasOne and ManyToOne
From a IDmlEntity, infer the foreign keys name and type for
"belongsTo" relation meaning "hasOne" and "ManyToOne"
## Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InferForeignKeys"/>
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="InferForeignKeys"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferHasManyFields/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# InferHasManyFields
**InferHasManyFields**: Relation extends () => [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer R, any&#62; ? [InferSchemaFields](../types.DmlTypes.InferSchemaFields/page.mdx)&#60;R&#62;[] : `never`
Infer fields for hasMany relationship
## Type Parameters
<TypeList types={[{"name":"Relation","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InferHasManyFields"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferHasOneFields/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# InferHasOneFields
**InferHasOneFields**: [InferBelongsToFields](../types.DmlTypes.InferBelongsToFields/page.mdx)&#60;Relation&#62;
Infer fields for a hasOne relationship
## Type Parameters
<TypeList types={[{"name":"Relation","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InferHasOneFields"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx
+1 -1
View File
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
# InferIndexableProperties
**InferIndexableProperties**: keyof T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer Schema&#62; ? &#123; [K in keyof Schema as Schema[K] extends Object ? Type extends RelationshipTypes ? never : K : K]: string &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;T&#62; : `never`
**InferIndexableProperties**: keyof T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer Schema, any&#62; ? &#123; [K in keyof Schema as Schema[K] extends Object ? Type extends RelationshipTypes ? never : K : K]: string &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;Schema&#62; : `never`
Infer all indexable properties from a DML entity including inferred foreign keys and excluding relationship
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferManyToManyFields/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# InferManyToManyFields
**InferManyToManyFields**: [InferHasManyFields](../types.DmlTypes.InferHasManyFields/page.mdx)&#60;Relation&#62;
Infer fields for manyToMany relationship
## Type Parameters
<TypeList types={[{"name":"Relation","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InferManyToManyFields"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx
+12
View File
@@ -0,0 +1,12 @@
import { TypeList } from "docs-ui"
# InferSchemaFields
**InferSchemaFields**: [Prettify](../../../CommonTypes/types/types.CommonTypes.Prettify/page.mdx)&#60;&#123; [K in keyof Schema]: Schema[K] extends RelationshipType&#60;any&#62; ? Schema[K]["type"] extends "belongsTo" ? InferBelongsToFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasOne" ? InferHasOneFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasMany" ? InferHasManyFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "manyToMany" ? InferManyToManyFields&#60;Schema[K]["$dataType"]&#62; : never : Schema[K]["$dataType"] &#125;&#62;
Inferring the types of the schema fields from the DML
entity
## Type Parameters
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="InferSchemaFields"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ Helper to infer the instance type of a IDmlEntity once converted as an Entity
## Type Parameters
<TypeList types={[{"name":"T","type":"[IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;any&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`true`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="InferTypeOf"/>
<TypeList types={[{"name":"T","type":"[IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;any, any&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`true`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)&#60;Config&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="InferTypeOf"/>

Some files were not shown because too many files have changed in this diff Show More