chore(docs): Generated References (#9026)
Generated the following references: - `modules` - `product` - `promotion` - `types`
This commit is contained in:
github-actions[bot] authored and 
GitHub committed
1 parent
abe7b66999
commit
a5748c6e1f
47 files changed
+1720800
-1718144
No files matched your search
@@ -537,8 +537,8 @@ export const generatedEditDates = {
|
||||
"references/stock_location_next/interfaces/stock_location_next.ShippingOptionTypeDTO/page.mdx": "2024-08-28T00:11:34.911Z",
|
||||
"references/stock_location_next/interfaces/stock_location_next.ShippingProfileDTO/page.mdx": "2024-08-28T00:11:34.931Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.AdminOptions/page.mdx": "2024-08-28T00:11:04.822Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ConfigModule/page.mdx": "2024-08-28T00:11:04.826Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ProjectConfigOptions/page.mdx": "2024-08-28T00:11:04.826Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ConfigModule/page.mdx": "2024-09-06T00:11:07.142Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ProjectConfigOptions/page.mdx": "2024-09-06T00:11:07.142Z",
|
||||
"references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx": "2024-08-28T00:11:04.918Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx": "2024-08-28T00:11:04.942Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimRequestResponse/page.mdx": "2024-09-04T00:11:02.669Z",
|
||||
@@ -940,5 +940,24 @@ export const generatedEditDates = {
|
||||
"references/types/interfaces/types.AdminExchangeAddShippingMethod/page.mdx": "2024-09-05T00:11:16.994Z",
|
||||
"references/types/interfaces/types.AdminExchangeUpdateShippingMethod/page.mdx": "2024-09-05T00:11:16.998Z",
|
||||
"references/types/interfaces/types.DetailWidgetProps/page.mdx": "2024-09-05T00:11:16.614Z",
|
||||
"references/types/types.WorkflowsSdkTypes/page.mdx": "2024-09-05T00:11:18.138Z"
|
||||
"references/types/types.WorkflowsSdkTypes/page.mdx": "2024-09-05T00:11:18.138Z",
|
||||
"references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptionValues/page.mdx": "2024-09-06T00:11:37.994Z",
|
||||
"references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptionValues/page.mdx": "2024-09-06T00:11:38.002Z",
|
||||
"references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptionValues/page.mdx": "2024-09-06T00:11:37.990Z",
|
||||
"references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptionValues/page.mdx": "2024-09-06T00:11:37.986Z",
|
||||
"references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptionValues/page.mdx": "2024-09-06T00:11:38.006Z",
|
||||
"references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptionValues/page.mdx": "2024-09-06T00:11:38.002Z",
|
||||
"references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptionValues/page.mdx": "2024-09-06T00:11:37.998Z",
|
||||
"references/product/interfaces/product.CreateProductOptionValueDTO/page.mdx": "2024-09-06T00:11:37.826Z",
|
||||
"references/product/interfaces/product.FilterableProductOptionValueProps/page.mdx": "2024-09-06T00:11:37.802Z",
|
||||
"references/product/interfaces/product.UpdateProductOptionValueDTO/page.mdx": "2024-09-06T00:11:37.830Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage/page.mdx": "2024-09-06T00:11:38.310Z",
|
||||
"references/promotion/types/promotion.UsageComputedActions/page.mdx": "2024-09-06T00:11:38.258Z",
|
||||
"references/modules/product/page.mdx": "2024-09-06T00:11:37.694Z",
|
||||
"references/modules/promotion/page.mdx": "2024-09-06T00:11:38.206Z",
|
||||
"references/product/interfaces/product.IProductModuleService/page.mdx": "2024-09-06T00:11:37.846Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.registerUsage/page.mdx": "2024-09-06T00:11:38.306Z",
|
||||
"references/promotion/interfaces/promotion.IPromotionModuleService/page.mdx": "2024-09-06T00:11:38.306Z",
|
||||
"references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService/page.mdx": "2024-09-06T00:11:07.298Z",
|
||||
"references/types/TransactionBaseTypes/interfaces/types.TransactionBaseTypes.ITransactionBaseService/page.mdx": "2024-09-06T00:11:08.494Z"
|
||||
}
|
||||
@@ -11667,6 +11667,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCollections/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCollections"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptionValues/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptionValues"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptions/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptions"
|
||||
@@ -11695,6 +11699,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductCollections/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductCollections"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptionValues/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptionValues"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptions/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptions"
|
||||
@@ -11723,6 +11731,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductCollections/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductCollections"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptionValues/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptionValues"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptions/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptions"
|
||||
@@ -11751,6 +11763,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listProductCollections/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.listProductCollections"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptionValues/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptionValues"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptions/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptions"
|
||||
@@ -11779,6 +11795,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCollections/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCollections"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptionValues/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptionValues"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptions/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptions"
|
||||
@@ -11835,6 +11855,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductCollections/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductCollections"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptionValues/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptionValues"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptions/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptions"
|
||||
@@ -11863,6 +11887,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductCollections/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductCollections"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptionValues/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptionValues"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptions/page.mdx",
|
||||
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptions"
|
||||
@@ -11935,6 +11963,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.CreateProductOptionDTO/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.CreateProductOptionDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.CreateProductOptionValueDTO/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.CreateProductOptionValueDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.CreateProductTagDTO/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.CreateProductTagDTO"
|
||||
@@ -11959,6 +11991,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.FilterableProductOptionProps/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.FilterableProductOptionProps"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.FilterableProductOptionValueProps/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.FilterableProductOptionValueProps"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.FilterableProductProps/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.FilterableProductProps"
|
||||
@@ -12067,6 +12103,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.UpdateProductOptionDTO/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.UpdateProductOptionDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.UpdateProductOptionValueDTO/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.UpdateProductOptionValueDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/product/interfaces/product.UpdateProductTagDTO/page.mdx",
|
||||
"pathname": "/references/product/interfaces/product.UpdateProductTagDTO"
|
||||
@@ -12343,6 +12383,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.retrievePromotion/page.mdx",
|
||||
"pathname": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.retrievePromotion"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage/page.mdx",
|
||||
"pathname": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.softDeleteCampaigns/page.mdx",
|
||||
"pathname": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.softDeleteCampaigns"
|
||||
@@ -12639,6 +12683,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/promotion/types/promotion.Scalar/page.mdx",
|
||||
"pathname": "/references/promotion/types/promotion.Scalar"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/promotion/types/promotion.UsageComputedActions/page.mdx",
|
||||
"pathname": "/references/promotion/types/promotion.UsageComputedActions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.ApplicationMethod/page.mdx",
|
||||
"pathname": "/references/promotion_models/classes/promotion_models.ApplicationMethod"
|
||||
|
||||
@@ -5110,6 +5110,14 @@ export const generatedSidebar = [
|
||||
"title": "createProductCollections",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/product/createProductOptionValues",
|
||||
"title": "createProductOptionValues",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -5166,6 +5174,14 @@ export const generatedSidebar = [
|
||||
"title": "deleteProductCollections",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/product/deleteProductOptionValues",
|
||||
"title": "deleteProductOptionValues",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -5222,6 +5238,14 @@ export const generatedSidebar = [
|
||||
"title": "listAndCountProductCollections",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/product/listAndCountProductOptionValues",
|
||||
"title": "listAndCountProductOptionValues",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -5278,6 +5302,14 @@ export const generatedSidebar = [
|
||||
"title": "listProductCollections",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/product/listProductOptionValues",
|
||||
"title": "listProductOptionValues",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -5334,6 +5366,14 @@ export const generatedSidebar = [
|
||||
"title": "restoreProductCollections",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/product/restoreProductOptionValues",
|
||||
"title": "restoreProductOptionValues",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -5446,6 +5486,14 @@ export const generatedSidebar = [
|
||||
"title": "softDeleteProductCollections",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/product/softDeleteProductOptionValues",
|
||||
"title": "softDeleteProductOptionValues",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -5502,6 +5550,14 @@ export const generatedSidebar = [
|
||||
"title": "updateProductCollections",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/product/updateProductOptionValues",
|
||||
"title": "updateProductOptionValues",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -5977,6 +6033,14 @@ export const generatedSidebar = [
|
||||
"title": "retrievePromotion",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/promotion/revertUsage",
|
||||
"title": "revertUsage",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
|
||||
@@ -5359,6 +5359,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/product/createProductCollections",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCollections/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptionValues",
|
||||
"newSlug": "/references/product/createProductOptionValues",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptionValues/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptions",
|
||||
"newSlug": "/references/product/createProductOptions",
|
||||
@@ -5394,6 +5399,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/product/deleteProductCollections",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductCollections/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptionValues",
|
||||
"newSlug": "/references/product/deleteProductOptionValues",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptionValues/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptions",
|
||||
"newSlug": "/references/product/deleteProductOptions",
|
||||
@@ -5429,6 +5439,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/product/listAndCountProductCollections",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductCollections/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptionValues",
|
||||
"newSlug": "/references/product/listAndCountProductOptionValues",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptionValues/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptions",
|
||||
"newSlug": "/references/product/listAndCountProductOptions",
|
||||
@@ -5464,6 +5479,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/product/listProductCollections",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listProductCollections/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptionValues",
|
||||
"newSlug": "/references/product/listProductOptionValues",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptionValues/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptions",
|
||||
"newSlug": "/references/product/listProductOptions",
|
||||
@@ -5499,6 +5519,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/product/restoreProductCollections",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCollections/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptionValues",
|
||||
"newSlug": "/references/product/restoreProductOptionValues",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptionValues/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptions",
|
||||
"newSlug": "/references/product/restoreProductOptions",
|
||||
@@ -5569,6 +5594,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/product/softDeleteProductCollections",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductCollections/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptionValues",
|
||||
"newSlug": "/references/product/softDeleteProductOptionValues",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptionValues/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptions",
|
||||
"newSlug": "/references/product/softDeleteProductOptions",
|
||||
@@ -5604,6 +5634,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/product/updateProductCollections",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductCollections/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptionValues",
|
||||
"newSlug": "/references/product/updateProductOptionValues",
|
||||
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptionValues/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptions",
|
||||
"newSlug": "/references/product/updateProductOptions",
|
||||
@@ -5829,6 +5864,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/promotion/retrievePromotion",
|
||||
"filePath": "/www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.retrievePromotion/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage",
|
||||
"newSlug": "/references/promotion/revertUsage",
|
||||
"filePath": "/www/apps/resources/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.softDeleteCampaigns",
|
||||
"newSlug": "/references/promotion/softDeleteCampaigns",
|
||||
|
||||
@@ -27,6 +27,7 @@ import { TypeList } from "docs-ui"
|
||||
- [FilterableProductTagProps](../../product/interfaces/product.FilterableProductTagProps/page.mdx)
|
||||
- [FilterableProductTypeProps](../../product/interfaces/product.FilterableProductTypeProps/page.mdx)
|
||||
- [FilterableProductOptionProps](../../product/interfaces/product.FilterableProductOptionProps/page.mdx)
|
||||
- [FilterableProductOptionValueProps](../../product/interfaces/product.FilterableProductOptionValueProps/page.mdx)
|
||||
- [FilterableProductCollectionProps](../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)
|
||||
- [FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)
|
||||
- [FilterableProductCategoryProps](../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)
|
||||
@@ -42,8 +43,10 @@ import { TypeList } from "docs-ui"
|
||||
- [UpsertProductTagDTO](../../product/interfaces/product.UpsertProductTagDTO/page.mdx)
|
||||
- [UpdateProductTagDTO](../../product/interfaces/product.UpdateProductTagDTO/page.mdx)
|
||||
- [CreateProductOptionDTO](../../product/interfaces/product.CreateProductOptionDTO/page.mdx)
|
||||
- [CreateProductOptionValueDTO](../../product/interfaces/product.CreateProductOptionValueDTO/page.mdx)
|
||||
- [UpsertProductOptionDTO](../../product/interfaces/product.UpsertProductOptionDTO/page.mdx)
|
||||
- [UpdateProductOptionDTO](../../product/interfaces/product.UpdateProductOptionDTO/page.mdx)
|
||||
- [UpdateProductOptionValueDTO](../../product/interfaces/product.UpdateProductOptionValueDTO/page.mdx)
|
||||
- [CreateProductVariantDTO](../../product/interfaces/product.CreateProductVariantDTO/page.mdx)
|
||||
- [UpsertProductVariantDTO](../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)
|
||||
- [UpdateProductVariantDTO](../../product/interfaces/product.UpdateProductVariantDTO/page.mdx)
|
||||
|
||||
@@ -72,6 +72,7 @@ import { TypeList } from "docs-ui"
|
||||
- [ApplicationMethodAllocationValues](../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)
|
||||
- [CampaignBudgetTypeValues](../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)
|
||||
- [ComputeActions](../../promotion/types/promotion.ComputeActions/page.mdx)
|
||||
- [UsageComputedActions](../../promotion/types/promotion.UsageComputedActions/page.mdx)
|
||||
- [PromotionRuleOperatorValues](../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)
|
||||
- [PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)
|
||||
- [BigNumberRawValue](../../promotion/types/promotion.BigNumberRawValue/page.mdx)
|
||||
|
||||
+59
@@ -0,0 +1,59 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
slug: /references/product/createProductOptionValues
|
||||
sidebar_label: createProductOptionValues
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# createProductOptionValues - Product Module Reference
|
||||
|
||||
This documentation provides a reference to the `createProductOptionValues` method. This belongs to the Product Module.
|
||||
|
||||
## createProductOptionValues(data, sharedContext?): Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]>
|
||||
|
||||
This method is used to create product option values.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
const options = await productModuleService.createProductOptionValues([
|
||||
{
|
||||
value: "Blue",
|
||||
option_id: "opt_123",
|
||||
},
|
||||
{
|
||||
value: "Green",
|
||||
option_id: "opt_123",
|
||||
},
|
||||
])
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateProductOptionValueDTO](../../../interfaces/product.CreateProductOptionValueDTO/page.mdx)[]","description":"The product option values to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/product.MetadataType/page.mdx)","description":"The metadata of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/product.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/product.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductOptionValues"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The list of created product option values.","expandable":false,"children":[{"name":"ProductOptionValueDTO[]","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductOptionValueDTO","type":"`object`","description":"The product option value's data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductOptionValues"/>
|
||||
|
||||
## createProductOptionValues(data, sharedContext?): Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)>
|
||||
|
||||
This method is used to create a product option.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
const option = await productModuleService.createProductOptionValues({
|
||||
value: "Blue",
|
||||
option_id: "opt_123",
|
||||
})
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateProductOptionValueDTO](../../../interfaces/product.CreateProductOptionValueDTO/page.mdx)","description":"The product option to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/product.MetadataType/page.mdx)","description":"The metadata of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/product.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/product.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductOptionValues"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The created product option.","expandable":false,"children":[{"name":"ProductOptionValueDTO","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)","optional":false,"defaultValue":"","description":"The product option value's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductOptionValues"/>
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
slug: /references/product/deleteProductOptionValues
|
||||
sidebar_label: deleteProductOptionValues
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# deleteProductOptionValues - Product Module Reference
|
||||
|
||||
This documentation provides a reference to the `deleteProductOptionValues` method. This belongs to the Product Module.
|
||||
|
||||
This method is used to delete a product option.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
await productModuleService.deleteProductOptionValues([
|
||||
"optval_123",
|
||||
"optval_321",
|
||||
])
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"productOptionValueIds","type":"`string`[]","description":"The IDs of the product option values to delete.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/product.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/product.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductOptionValues"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when the product option values are successfully deleted.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductOptionValues"/>
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
slug: /references/product/listAndCountProductOptionValues
|
||||
sidebar_label: listAndCountProductOptionValues
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# listAndCountProductOptionValues - Product Module Reference
|
||||
|
||||
This documentation provides a reference to the `listAndCountProductOptionValues` method. This belongs to the Product Module.
|
||||
|
||||
This method is used to retrieve a paginated list of product option values along with the total count of available product option values satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
To retrieve a list of product option values using their IDs:
|
||||
|
||||
```ts
|
||||
const [options, count] =
|
||||
await productModuleService.listAndCountProductOptionValues({
|
||||
id: ["optval_123", "optval_321"],
|
||||
})
|
||||
```
|
||||
|
||||
To specify relations that should be retrieved within the product types:
|
||||
|
||||
```ts
|
||||
const [options, count] =
|
||||
await productModuleService.listAndCountProductOptionValues(
|
||||
{
|
||||
id: ["optval_123", "optval_321"],
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
const [options, count] =
|
||||
await productModuleService.listAndCountProductOptionValues(
|
||||
{
|
||||
id: ["optval_123", "optval_321"],
|
||||
},
|
||||
{
|
||||
take: 20,
|
||||
skip: 2,
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters applied on the retrieved product option values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandableLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[], number]>","optional":false,"defaultValue":"","description":"The list of product option values along with the total count.","expandable":false,"children":[{"name":"ProductOptionValueDTO[]","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listAndCountProductOptionValues"/>
|
||||
+55
@@ -0,0 +1,55 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
slug: /references/product/listProductOptionValues
|
||||
sidebar_label: listProductOptionValues
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# listProductOptionValues - Product Module Reference
|
||||
|
||||
This documentation provides a reference to the `listProductOptionValues` method. This belongs to the Product Module.
|
||||
|
||||
This method is used to retrieve a paginated list of product option values based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
To retrieve a list of product option values using their IDs:
|
||||
|
||||
```ts
|
||||
const options = await productModuleService.listProductOptionValues({
|
||||
id: ["optval_123", "optval_321"],
|
||||
})
|
||||
```
|
||||
|
||||
To specify relations that should be retrieved within the product option values:
|
||||
|
||||
```ts
|
||||
const options = await productModuleService.listProductOptionValues(
|
||||
{
|
||||
id: ["optval_123", "optval_321"],
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
const options = await productModuleService.listProductOptionValues(
|
||||
{
|
||||
id: ["optval_123", "optval_321"],
|
||||
},
|
||||
{
|
||||
take: 20,
|
||||
skip: 2,
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters applied on the retrieved product option values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandableLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The list of product option values.","expandable":false,"children":[{"name":"ProductOptionValueDTO[]","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductOptionValueDTO","type":"`object`","description":"The product option value's data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listProductOptionValues"/>
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
slug: /references/product/restoreProductOptionValues
|
||||
sidebar_label: restoreProductOptionValues
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# restoreProductOptionValues - Product Module Reference
|
||||
|
||||
This documentation provides a reference to the `restoreProductOptionValues` method. This belongs to the Product Module.
|
||||
|
||||
This method is used to restore options which were deleted using the softDelete method.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
await productModuleService.restoreProductOptionValues([
|
||||
"optval_123",
|
||||
"optval_321",
|
||||
])
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"optionIds","type":"`string`[]","description":"The IDs of the options to restore.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[RestoreReturn](../../../interfaces/product.RestoreReturn/page.mdx)<TReturnableLinkableKeys>","description":"Configurations determining which relations to restore along with each of the options. You can pass to its `returnLinkableKeys`\nproperty any of the option's relation attribute names.","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/product.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/product.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="restoreProductOptionValues"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void \\| Record<string, string[]>>","optional":false,"defaultValue":"","description":"An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the option entity's relations, and its value is an array of strings, each being the ID of the record associated with the option through this relation.\n\nIf there are no related records that were restored, the promise resolved to `void`.","expandable":false,"children":[{"name":"void \\| Record<string, string[]>","type":"`void` \\| `Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="restoreProductOptionValues"/>
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
slug: /references/product/softDeleteProductOptionValues
|
||||
sidebar_label: softDeleteProductOptionValues
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# softDeleteProductOptionValues - Product Module Reference
|
||||
|
||||
This documentation provides a reference to the `softDeleteProductOptionValues` method. This belongs to the Product Module.
|
||||
|
||||
This method is used to delete options. Unlike the delete method, this method won't completely remove the option. It can still be accessed or retrieved using methods like retrieve if you pass the `withDeleted` property to the `config` object parameter.
|
||||
|
||||
The soft-deleted options can be restored using the restore method.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
await productModuleService.softDeleteProductOptionValues([
|
||||
"optval_123",
|
||||
"optval_321",
|
||||
])
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"optionIds","type":"`string`[]","description":"The IDs of the options to soft-delete.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[SoftDeleteReturn](../../../interfaces/product.SoftDeleteReturn/page.mdx)<TReturnableLinkableKeys>","description":"Configurations determining which relations to soft delete along with the each of the options. You can pass to its `returnLinkableKeys`\nproperty any of the option's relation attribute names, such as `option_value_id`.","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/product.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/product.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="softDeleteProductOptionValues"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void \\| Record<string, string[]>>","optional":false,"defaultValue":"","description":"An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the option entity's relations, and its value is an array of strings, each being the ID of a record associated with the option through this relation.\n\nIf there are no related records, the promise resolved to `void`.","expandable":false,"children":[{"name":"void \\| Record<string, string[]>","type":"`void` \\| `Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="softDeleteProductOptionValues"/>
|
||||
+59
@@ -0,0 +1,59 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
slug: /references/product/updateProductOptionValues
|
||||
sidebar_label: updateProductOptionValues
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# updateProductOptionValues - Product Module Reference
|
||||
|
||||
This documentation provides a reference to the `updateProductOptionValues` method. This belongs to the Product Module.
|
||||
|
||||
## updateProductOptionValues(id, data, sharedContext?): Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)>
|
||||
|
||||
This method is used to update a option.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
const option = await productModuleService.updateProductOptionValues(
|
||||
"optval_123",
|
||||
{
|
||||
value: "Green",
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the option to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"[UpdateProductOptionValueDTO](../../../interfaces/product.UpdateProductOptionValueDTO/page.mdx)","description":"The attributes of the option to be updated","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The value of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/product.MetadataType/page.mdx)","description":"The metadata of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/product.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/product.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProductOptionValues"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The updated option.","expandable":false,"children":[{"name":"ProductOptionValueDTO","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)","optional":false,"defaultValue":"","description":"The product option value's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProductOptionValues"/>
|
||||
|
||||
## updateProductOptionValues(selector, data, sharedContext?): Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]>
|
||||
|
||||
This method is used to update a list of options matching the specified filters.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
const options = await productModuleService.updateProductOptionValues(
|
||||
{
|
||||
value: "Green",
|
||||
},
|
||||
{
|
||||
value: ["Red"],
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters specifying which options to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"cLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The updated options.","expandable":false,"children":[{"name":"ProductOptionValueDTO[]","type":"[ProductOptionValueDTO](../../../interfaces/product.ProductOptionValueDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductOptionValueDTO","type":"`object`","description":"The product option value's data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProductOptionValues"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CreateProductOptionValueDTO
|
||||
|
||||
<TypeList types={[{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../types/product.MetadataType/page.mdx)","description":"The metadata of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CreateProductOptionValueDTO"/>
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# FilterableProductOptionValueProps
|
||||
|
||||
The filters to apply on retrieved product option values.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","tyLine truncated
|
||||
+7
@@ -49,6 +49,13 @@ The main service interface for the Product Module.
|
||||
- [deleteProductOptions](../../IProductModuleService/methods/product.IProductModuleService.deleteProductOptions/page.mdx)
|
||||
- [softDeleteProductOptions](../../IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptions/page.mdx)
|
||||
- [restoreProductOptions](../../IProductModuleService/methods/product.IProductModuleService.restoreProductOptions/page.mdx)
|
||||
- [listProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.listProductOptionValues/page.mdx)
|
||||
- [listAndCountProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptionValues/page.mdx)
|
||||
- [createProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.createProductOptionValues/page.mdx)
|
||||
- [updateProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.updateProductOptionValues/page.mdx)
|
||||
- [deleteProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.deleteProductOptionValues/page.mdx)
|
||||
- [softDeleteProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptionValues/page.mdx)
|
||||
- [restoreProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.restoreProductOptionValues/page.mdx)
|
||||
- [retrieveProductVariant](../../IProductModuleService/methods/product.IProductModuleService.retrieveProductVariant/page.mdx)
|
||||
- [listProductVariants](../../IProductModuleService/methods/product.IProductModuleService.listProductVariants/page.mdx)
|
||||
- [listAndCountProductVariants](../../IProductModuleService/methods/product.IProductModuleService.listAndCountProductVariants/page.mdx)
|
||||
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
---
|
||||
displayed_sidebar: productReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# UpdateProductOptionValueDTO
|
||||
|
||||
<TypeList types={[{"name":"value","type":"`string`","description":"The value of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../types/product.MetadataType/page.mdx)","description":"The metadata of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateProductOptionValueDTO"/>
|
||||
+1
-5
@@ -19,14 +19,10 @@ computed actions.
|
||||
```ts
|
||||
await promotionModuleService.registerUsage([
|
||||
{
|
||||
action: "addItemAdjustment",
|
||||
item_id: "cali_123",
|
||||
amount: 50,
|
||||
code: "50OFF",
|
||||
},
|
||||
{
|
||||
action: "addShippingMethodAdjustment",
|
||||
shipping_method_id: "casm_123",
|
||||
amount: 5000,
|
||||
code: "FREESHIPPING",
|
||||
},
|
||||
@@ -35,7 +31,7 @@ await promotionModuleService.registerUsage([
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"computedActions","type":"[ComputeActions](../../../types/promotion.ComputeActions/page.mdx)[]","description":"The computed actions to adjust their promotion's campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"`\"addItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the item's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"addShippingMethodAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the shipping method's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeShippingMethodAdjustment\"`","description":"The type of action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"campaignBudgetExceeded\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerUsage"/>
|
||||
<TypeList types={[{"name":"computedActions","type":"[UsageComputedActions](../../../types/promotion.UsageComputedActions/page.mdx)[]","description":"The computed actions to adjust their promotion's campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"[BigNumberInput](../../../types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the shipping method's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerUsage"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
---
|
||||
displayed_sidebar: promotionReference
|
||||
slug: /references/promotion/revertUsage
|
||||
sidebar_label: revertUsage
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# revertUsage - Promotion Module Reference
|
||||
|
||||
This documentation provides a reference to the `revertUsage` method. This belongs to the Promotion Module.
|
||||
|
||||
This method is used to revert the changes made by registerUsage action
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
await promotionModuleService.revertUsage([
|
||||
{
|
||||
amount: 50,
|
||||
code: "50OFF",
|
||||
},
|
||||
{
|
||||
amount: 5000,
|
||||
code: "FREESHIPPING",
|
||||
},
|
||||
])
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"computedActions","type":"[UsageComputedActions](../../../types/promotion.UsageComputedActions/page.mdx)[]","description":"The computed actions to adjust their promotion's campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"[BigNumberInput](../../../types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the shipping method's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revertUsage"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when the campaign budgets have been adjusted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revertUsage"/>
|
||||
+1
@@ -14,6 +14,7 @@ The main service interface for the Promotion Module.
|
||||
## Methods
|
||||
|
||||
- [registerUsage](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.registerUsage/page.mdx)
|
||||
- [revertUsage](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage/page.mdx)
|
||||
- [computeActions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.computeActions/page.mdx)
|
||||
- [createPromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.createPromotions/page.mdx)
|
||||
- [updatePromotions](../../IPromotionModuleService/methods/promotion.IPromotionModuleService.updatePromotions/page.mdx)
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
displayed_sidebar: promotionReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# UsageComputedActions
|
||||
|
||||
**UsageComputedActions**: `Object`
|
||||
|
||||
These computed action types can affect a campaign's budget.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"amount","type":"[BigNumberInput](../promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the shipping method's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UsageComputedActions"/>
|
||||
+1
-1
@@ -45,4 +45,4 @@ setting the environment variables depends on the hosting provider.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"projectConfig","type":"[ProjectConfigOptions](../types.CommonTypes.ProjectConfigOptions/page.mdx)","description":"This property holds essential configurations related to the Medusa application, such as database and CORS configurations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/v2/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authMethodsPerLine truncated
|
||||
<TypeList types={[{"name":"projectConfig","type":"[ProjectConfigOptions](../types.CommonTypes.ProjectConfigOptions/page.mdx)","description":"This property holds essential configurations related to the Medusa application, such as database and CORS configurations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/v2/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authMethodsPerLine truncated
|
||||
+1
-1
@@ -6,4 +6,4 @@ Essential configurations related to the Medusa application, such as database and
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/v2/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression butLine truncated
|
||||
<TypeList types={[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/v2/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression butLine truncated
|
||||
-10
@@ -37,13 +37,3 @@ import { TypeList } from "docs-ui"
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<unknown>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown","type":"`unknown`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="emit"/>
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="withTransaction"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="withTransaction"/>
|
||||
-12
@@ -1,15 +1,3 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ITransactionBaseService
|
||||
|
||||
## Methods
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="withTransaction"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="withTransaction"/>
|
||||
Reference in new issue
Block a user