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

docs: generate references manually (#10325)

Browse Source 
* docs: generate references

* prep changes
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-11-27 19:27:25 +02:00
1 parent 137913b469
commit 030b0cc095
153 files changed
+183455 -140828
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/generated/edit-dates.mjs
+85 -36
View File
@@ -536,7 +536,7 @@ export const generatedEditDates = {
"references/types/WorkflowsSdkTypes/interfaces/types.WorkflowsSdkTypes.WorkflowOrchestratorRunDTO/page.mdx": "2024-09-17T00:10:59.355Z",
"references/types/interfaces/types.BaseExchange/page.mdx": "2024-11-06T21:08:40.718Z",
"references/types/interfaces/types.BaseReturn/page.mdx": "2024-09-20T00:12:03.021Z",
"references/types/types.DmlTypes/page.mdx": "2024-11-25T17:49:25.491Z",
"references/types/types.DmlTypes/page.mdx": "2024-11-27T16:33:39.160Z",
"references/types/types.ModulesSdkTypes/page.mdx": "2024-11-25T17:49:27.891Z",
"references/types/types/types.FlowRunOptions/page.mdx": "2024-09-17T00:10:59.375Z",
"references/fulfillment_models/classes/fulfillment_models.FulfillmentAddress/page.mdx": "2024-08-29T00:11:41.369Z",
@@ -737,7 +737,7 @@ export const generatedEditDates = {
"references/core_flows/types/core_flows.UpdateOrderTaxLinesWorkflowInput/page.mdx": "2024-10-23T07:15:51.436Z",
"references/core_flows/types/core_flows.UpdateTaxLinesWorkflowInput/page.mdx": "2024-11-06T21:09:04.554Z",
"references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx": "2024-11-25T17:49:51.632Z",
"references/modules/types/page.mdx": "2024-11-25T17:49:25.251Z",
"references/modules/types/page.mdx": "2024-11-27T16:33:39.041Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx": "2024-11-06T21:09:11.354Z",
"references/order/interfaces/order.CancelOrderClaimDTO/page.mdx": "2024-10-03T00:12:17.706Z",
"references/order/interfaces/order.CancelOrderExchangeDTO/page.mdx": "2024-10-03T00:12:17.711Z",
@@ -929,8 +929,8 @@ export const generatedEditDates = {
"references/product/interfaces/product.UpdateProductOptionValueDTO/page.mdx": "2024-09-06T00:11:37.830Z",
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.revertUsage/page.mdx": "2024-10-23T07:16:00.064Z",
"references/promotion/types/promotion.UsageComputedActions/page.mdx": "2024-10-23T07:16:00.012Z",
"references/modules/product/page.mdx": "2024-11-25T17:49:57.980Z",
"references/modules/promotion/page.mdx": "2024-11-25T17:49:58.508Z",
"references/modules/product/page.mdx": "2024-11-27T16:33:56.077Z",
"references/modules/promotion/page.mdx": "2024-11-27T16:33:56.357Z",
"references/product/interfaces/product.IProductModuleService/page.mdx": "2024-11-25T17:49:58.144Z",
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.registerUsage/page.mdx": "2024-10-23T07:16:00.064Z",
"references/promotion/interfaces/promotion.IPromotionModuleService/page.mdx": "2024-11-25T17:49:58.612Z",
@@ -999,7 +999,7 @@ export const generatedEditDates = {
"references/types/types.CommonTypes/page.mdx": "2024-11-25T17:49:25.351Z",
"app/storefront-development/publishable-api-keys/page.mdx": "2024-09-11T09:35:46.683Z",
"references/api_key/types/api_key.ExpandScalar/page.mdx": "2024-09-17T00:10:59.563Z",
"references/api_key/types/api_key.FilterQuery/page.mdx": "2024-09-17T00:10:59.575Z",
"references/api_key/types/api_key.FilterQuery/page.mdx": "2024-11-27T16:33:40.706Z",
"references/api_key/types/api_key.FilterValue/page.mdx": "2024-09-17T00:10:59.571Z",
"references/api_key/types/api_key.FilterValue2/page.mdx": "2024-09-17T00:10:59.571Z",
"references/api_key/types/api_key.OperatorMap/page.mdx": "2024-10-23T07:15:29.448Z",
@@ -1221,10 +1221,10 @@ export const generatedEditDates = {
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.belongsTo/page.mdx": "2024-10-03T00:12:15.469Z",
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasMany/page.mdx": "2024-10-03T00:12:15.471Z",
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx": "2024-10-03T00:12:15.468Z",
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx": "2024-10-03T00:12:15.472Z",
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx": "2024-11-27T16:33:52.369Z",
"references/dml/entity/classes/dml.entity.DmlEntity/page.mdx": "2024-11-25T17:49:50.520Z",
"references/dml/entity_builder/EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx": "2024-10-03T00:12:15.442Z",
"references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx": "2024-10-23T07:15:51.944Z",
"references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx": "2024-11-27T16:33:52.350Z",
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2024-10-14T15:28:21.810Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillmentSets/page.mdx": "2024-10-23T07:15:52.432Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createGeoZones/page.mdx": "2024-10-23T07:15:52.516Z",
@@ -1328,9 +1328,9 @@ export const generatedEditDates = {
"references/inventory_next/interfaces/inventory_next.JoinerServiceConfig/page.mdx": "2024-11-11T10:32:06.531Z",
"references/inventory_next/interfaces/inventory_next.JoinerServiceConfigAlias/page.mdx": "2024-09-17T00:11:24.707Z",
"references/inventory_next/types/inventory_next.JoinerRelationship/page.mdx": "2024-10-23T07:15:53.292Z",
"references/modules/api_key/page.mdx": "2024-11-25T17:49:28.655Z",
"references/modules/api_key/page.mdx": "2024-11-27T16:33:40.668Z",
"references/modules/customer_models/page.mdx": "2024-11-25T17:49:50.228Z",
"references/modules/order/page.mdx": "2024-11-25T17:49:55.760Z",
"references/modules/order/page.mdx": "2024-11-27T16:33:54.918Z",
"references/modules/utils/page.mdx": "2024-11-25T17:49:28.511Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.applyPendingOrderActions/page.mdx": "2024-10-23T07:15:58.188Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelFulfillment/page.mdx": "2024-10-23T07:15:58.476Z",
@@ -1543,13 +1543,6 @@ export const generatedEditDates = {
"references/product/interfaces/product.JoinerServiceConfig/page.mdx": "2024-11-11T10:32:12.671Z",
"references/product/interfaces/product.JoinerServiceConfigAlias/page.mdx": "2024-09-17T00:11:27.423Z",
"references/product/types/product.JoinerRelationship/page.mdx": "2024-10-23T07:15:59.464Z",
"references/product_models/classes/product_models.Image/page.mdx": "2024-11-25T17:49:57.916Z",
"references/product_models/classes/product_models.Product/page.mdx": "2024-11-25T17:49:57.976Z",
"references/product_models/classes/product_models.ProductCategory/page.mdx": "2024-11-25T17:49:57.900Z",
"references/product_models/classes/product_models.ProductCollection/page.mdx": "2024-11-25T17:49:57.908Z",
"references/product_models/classes/product_models.ProductOption/page.mdx": "2024-11-25T17:49:57.936Z",
"references/product_models/classes/product_models.ProductTag/page.mdx": "2024-11-25T17:49:57.944Z",
"references/product_models/classes/product_models.ProductVariant/page.mdx": "2024-11-25T17:49:57.956Z",
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionBuyRules/page.mdx": "2024-10-23T07:16:00.104Z",
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionRules/page.mdx": "2024-10-23T07:16:00.100Z",
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionTargetRules/page.mdx": "2024-10-23T07:16:00.100Z",
@@ -1664,14 +1657,14 @@ export const generatedEditDates = {
"references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx": "2024-11-25T17:49:59.292Z",
"references/tax_provider/types/tax_provider.ItemTaxCalculationLine/page.mdx": "2024-11-06T21:09:13.482Z",
"references/tax_provider/types/tax_provider.ShippingTaxCalculationLine/page.mdx": "2024-10-24T13:48:35.084Z",
"references/types/DAL/interfaces/types.DAL.RepositoryService/page.mdx": "2024-10-23T07:15:27.604Z",
"references/types/DAL/interfaces/types.DAL.TreeRepositoryService/page.mdx": "2024-10-23T07:15:27.616Z",
"references/types/DAL/interfaces/types.DAL.RepositoryService/page.mdx": "2024-11-27T16:33:39.139Z",
"references/types/DAL/interfaces/types.DAL.TreeRepositoryService/page.mdx": "2024-11-27T16:33:39.144Z",
"references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx": "2024-11-25T17:49:25.611Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx": "2024-11-06T21:08:40.882Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx": "2024-11-06T21:08:40.878Z",
"references/types/InventoryTypes/interfaces/types.InventoryTypes.FilterableInventoryLevelProps/page.mdx": "2024-09-17T00:10:58.843Z",
"references/types/InventoryTypes/interfaces/types.InventoryTypes.IInventoryService/page.mdx": "2024-11-25T17:49:27.787Z",
"references/types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.IMedusaInternalService/page.mdx": "2024-11-25T17:49:27.967Z",
"references/types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.IMedusaInternalService/page.mdx": "2024-11-27T16:33:40.339Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx": "2024-09-17T00:10:59.027Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx": "2024-09-17T00:10:59.031Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx": "2024-10-23T07:15:28.780Z",
@@ -2123,7 +2116,7 @@ export const generatedEditDates = {
"references/inventory_next/interfaces/inventory_next.FilterableReservationItemProps/page.mdx": "2024-10-03T00:12:16.534Z",
"references/inventory_next/interfaces/inventory_next.IModuleService/page.mdx": "2024-11-25T17:49:51.828Z",
"references/inventory_next/interfaces/inventory_next.MessageAggregatorFormat/page.mdx": "2024-10-03T00:12:16.661Z",
"references/modules/fulfillment/page.mdx": "2024-11-25T17:49:50.684Z",
"references/modules/fulfillment/page.mdx": "2024-11-27T16:33:52.453Z",
"references/order/IMessageAggregator/methods/order.IMessageAggregator.getMessages/page.mdx": "2024-10-03T00:12:18.424Z",
"references/order/interfaces/order.CancelOrderFulfillmentDTO/page.mdx": "2024-10-03T00:12:17.654Z",
"references/order/interfaces/order.IModuleService/page.mdx": "2024-11-25T17:49:55.804Z",
@@ -2156,8 +2149,8 @@ export const generatedEditDates = {
"references/region/interfaces/region.MessageAggregatorFormat/page.mdx": "2024-10-03T00:12:20.033Z",
"references/region/interfaces/region.PaymentProviderDTO/page.mdx": "2024-10-03T00:12:19.973Z",
"references/region/interfaces/region.RegionDTO/page.mdx": "2024-10-03T00:12:19.974Z",
"references/region_models/variables/region_models.Country/page.mdx": "2024-10-03T00:12:19.930Z",
"references/region_models/variables/region_models.Region/page.mdx": "2024-10-03T00:12:19.934Z",
"references/region_models/variables/region_models.Country/page.mdx": "2024-11-27T16:33:56.468Z",
"references/region_models/variables/region_models.Region/page.mdx": "2024-11-27T16:33:56.471Z",
"references/sales_channel/IMessageAggregator/methods/sales_channel.IMessageAggregator.getMessages/page.mdx": "2024-10-03T00:12:20.117Z",
"references/sales_channel/interfaces/sales_channel.IModuleService/page.mdx": "2024-11-25T17:49:58.876Z",
"references/sales_channel/interfaces/sales_channel.MessageAggregatorFormat/page.mdx": "2024-10-03T00:12:20.113Z",
@@ -2249,7 +2242,7 @@ export const generatedEditDates = {
"references/customer/interfaces/customer.FindConfig/page.mdx": "2024-11-25T17:49:50.256Z",
"references/fulfillment/interfaces/fulfillment.FindConfig/page.mdx": "2024-11-25T17:49:50.688Z",
"references/inventory_next/interfaces/inventory_next.FindConfig/page.mdx": "2024-11-25T17:49:51.652Z",
"references/modules/payment/page.mdx": "2024-11-25T17:49:57.196Z",
"references/modules/payment/page.mdx": "2024-11-27T16:33:55.648Z",
"references/order/interfaces/order.FindConfig/page.mdx": "2024-11-25T17:49:55.764Z",
"references/order_models/classes/order_models.ReturnReason/page.mdx": "2024-10-14T09:11:42.573Z",
"references/payment/interfaces/payment.FindConfig/page.mdx": "2024-11-25T17:49:57.200Z",
@@ -2290,7 +2283,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx": "2024-10-25T15:35:28.081Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx": "2024-11-06T21:09:07.294Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx": "2024-10-25T15:35:27.829Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2024-11-25T17:49:52.812Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2024-11-27T16:33:53.517Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx": "2024-11-25T17:49:52.832Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx": "2024-11-06T21:09:07.554Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx": "2024-11-06T21:09:07.570Z",
@@ -2669,7 +2662,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/classes/js_sdk.admin.FulfillmentSet/page.mdx": "2024-11-25T17:49:52.396Z",
"references/js_sdk/admin/classes/js_sdk.admin.Invite/page.mdx": "2024-11-25T17:49:53.248Z",
"references/js_sdk/admin/classes/js_sdk.admin.Notification/page.mdx": "2024-11-25T17:49:53.304Z",
"references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx": "2024-11-25T17:49:53.420Z",
"references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx": "2024-11-27T16:33:53.800Z",
"references/js_sdk/admin/classes/js_sdk.admin.OrderEdit/page.mdx": "2024-11-25T17:49:53.348Z",
"references/js_sdk/admin/classes/js_sdk.admin.Payment/page.mdx": "2024-11-25T17:49:53.540Z",
"references/js_sdk/admin/classes/js_sdk.admin.PaymentCollection/page.mdx": "2024-11-25T17:49:53.492Z",
@@ -2901,7 +2894,7 @@ export const generatedEditDates = {
"references/medusa/types/medusa.MedusaContainer/page.mdx": "2024-10-23T07:15:27.368Z",
"references/modules/inventory_next_models/page.mdx": "2024-10-23T07:15:53.084Z",
"references/modules/stock_location_next_models/page.mdx": "2024-11-25T17:49:58.944Z",
"references/modules/tax/page.mdx": "2024-11-25T17:49:59.296Z",
"references/modules/tax/page.mdx": "2024-11-27T16:33:56.766Z",
"references/modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx": "2024-10-23T07:15:56.768Z",
"references/modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx": "2024-10-23T07:15:56.772Z",
"references/modules_sdk/types/modules_sdk.RevertMigrationFn/page.mdx": "2024-10-23T07:15:56.768Z",
@@ -2953,8 +2946,8 @@ export const generatedEditDates = {
"references/tax/types/tax.Event/page.mdx": "2024-10-23T07:16:00.760Z",
"references/tax/types/tax.OperatorMap/page.mdx": "2024-10-23T07:16:00.752Z",
"references/tax/types/tax.RawMessageFormat/page.mdx": "2024-10-23T07:16:00.760Z",
"references/types/DAL/interfaces/types.DAL.FindOptions/page.mdx": "2024-10-23T07:15:27.580Z",
"references/types/DAL/interfaces/types.DAL.OptionsQuery/page.mdx": "2024-10-23T07:15:27.576Z",
"references/types/DAL/interfaces/types.DAL.FindOptions/page.mdx": "2024-11-27T16:33:39.124Z",
"references/types/DAL/interfaces/types.DAL.OptionsQuery/page.mdx": "2024-11-27T16:33:39.124Z",
"references/types/EventBusTypes/types/types.EventBusTypes.Subscriber/page.mdx": "2024-10-23T07:15:27.700Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimInboundItems/page.mdx": "2024-10-23T07:15:27.884Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimItems/page.mdx": "2024-10-23T07:15:27.880Z",
@@ -3299,21 +3292,21 @@ export const generatedEditDates = {
"references/fulfillment/interfaces/fulfillment.IMessageAggregator/page.mdx": "2024-11-25T17:49:51.580Z",
"references/inventory_next/interfaces/inventory_next.IBigNumber/page.mdx": "2024-11-25T17:49:51.848Z",
"references/inventory_next/interfaces/inventory_next.IMessageAggregator/page.mdx": "2024-11-25T17:49:51.836Z",
"references/modules/cart/page.mdx": "2024-11-25T17:49:28.999Z",
"references/modules/cart/page.mdx": "2024-11-27T16:33:40.832Z",
"references/modules/cart_models/page.mdx": "2024-11-25T17:49:28.927Z",
"references/modules/currency/page.mdx": "2024-11-25T17:49:50.172Z",
"references/modules/customer/page.mdx": "2024-11-25T17:49:50.252Z",
"references/modules/customer/page.mdx": "2024-11-27T16:33:52.206Z",
"references/modules/dml/page.mdx": "2024-11-25T17:49:50.504Z",
"references/modules/inventory_next/page.mdx": "2024-11-25T17:49:51.652Z",
"references/modules/inventory_next/page.mdx": "2024-11-27T16:33:52.948Z",
"references/modules/medusa_config/page.mdx": "2024-11-25T17:49:55.224Z",
"references/modules/payment_models/page.mdx": "2024-11-25T17:49:57.100Z",
"references/modules/pricing/page.mdx": "2024-11-25T17:49:57.580Z",
"references/modules/pricing/page.mdx": "2024-11-27T16:33:55.845Z",
"references/modules/pricing_models/page.mdx": "2024-11-25T17:49:57.544Z",
"references/modules/product_models/page.mdx": "2024-11-25T17:49:57.884Z",
"references/modules/product_models/page.mdx": "2024-11-27T16:33:56.000Z",
"references/modules/promotion_models/page.mdx": "2024-11-25T17:49:58.440Z",
"references/modules/region/page.mdx": "2024-11-25T17:49:58.724Z",
"references/modules/region/page.mdx": "2024-11-27T16:33:56.472Z",
"references/modules/sales_channel/page.mdx": "2024-11-25T17:49:58.852Z",
"references/modules/stock_location_next/page.mdx": "2024-11-25T17:49:58.952Z",
"references/modules/stock_location_next/page.mdx": "2024-11-27T16:33:56.591Z",
"references/modules/store/page.mdx": "2024-11-25T17:49:59.160Z",
"references/modules/store_models/page.mdx": "2024-11-25T17:49:59.152Z",
"references/modules/tax_models/page.mdx": "2024-11-25T17:49:59.256Z",
@@ -3386,12 +3379,68 @@ export const generatedEditDates = {
"references/types/interfaces/types.BaseProductImage/page.mdx": "2024-11-25T17:49:27.563Z",
"references/types/interfaces/types.BaseProductTag/page.mdx": "2024-11-25T17:49:27.535Z",
"references/types/interfaces/types.BaseProductType/page.mdx": "2024-11-25T17:49:27.535Z",
"references/types/types.DAL/page.mdx": "2024-11-25T17:49:25.411Z",
"references/types/types.DAL/page.mdx": "2024-11-27T16:33:39.121Z",
"references/types/types.EventBusTypes/page.mdx": "2024-11-25T17:49:25.535Z",
"references/types/types.FileTypes/page.mdx": "2024-11-25T17:49:25.579Z",
"references/types/types.InventoryTypes/page.mdx": "2024-11-25T17:49:27.667Z",
"references/types/types.StockLocationTypes/page.mdx": "2024-11-25T17:49:28.127Z",
"references/user/interfaces/user.IMessageAggregator/page.mdx": "2024-11-25T17:49:59.536Z",
"references/utils/utils.PromotionUtils/page.mdx": "2024-11-25T17:49:28.611Z",
"references/api_key/types/api_key.Constructor/page.mdx": "2024-11-27T16:33:40.714Z",
"references/api_key/types/api_key.FilterQueryProperties/page.mdx": "2024-11-27T16:33:40.705Z",
"references/cart/types/cart.Constructor/page.mdx": "2024-11-27T16:33:41.063Z",
"references/cart/types/cart.FilterQueryProperties/page.mdx": "2024-11-27T16:33:41.056Z",
"references/customer/types/customer.Constructor/page.mdx": "2024-11-27T16:33:52.334Z",
"references/customer/types/customer.FilterQueryProperties/page.mdx": "2024-11-27T16:33:52.326Z",
"references/fulfillment/types/fulfillment.Constructor/page.mdx": "2024-11-27T16:33:52.768Z",
"references/fulfillment/types/fulfillment.FilterQueryProperties/page.mdx": "2024-11-27T16:33:52.464Z",
"references/inventory_next/types/inventory_next.Constructor/page.mdx": "2024-11-27T16:33:53.035Z",
"references/inventory_next/types/inventory_next.FilterQueryProperties/page.mdx": "2024-11-27T16:33:52.960Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelTransfer/page.mdx": "2024-11-27T16:33:53.827Z",
"references/order/types/order.Constructor/page.mdx": "2024-11-27T16:33:54.937Z",
"references/order/types/order.FilterQueryProperties/page.mdx": "2024-11-27T16:33:54.928Z",
"references/payment/types/payment.Constructor/page.mdx": "2024-11-27T16:33:55.669Z",
"references/payment/types/payment.FilterQueryProperties/page.mdx": "2024-11-27T16:33:55.662Z",
"references/pricing/types/pricing.Constructor/page.mdx": "2024-11-27T16:33:55.863Z",
"references/pricing/types/pricing.FilterQueryProperties/page.mdx": "2024-11-27T16:33:55.857Z",
"references/product/types/product.Constructor/page.mdx": "2024-11-27T16:33:56.095Z",
"references/product/types/product.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.088Z",
"references/product_models/variables/product_models.Image/page.mdx": "2024-11-27T16:33:56.023Z",
"references/product_models/variables/product_models.Product/page.mdx": "2024-11-27T16:33:56.076Z",
"references/product_models/variables/product_models.ProductCategory/page.mdx": "2024-11-27T16:33:56.008Z",
"references/product_models/variables/product_models.ProductCollection/page.mdx": "2024-11-27T16:33:56.016Z",
"references/product_models/variables/product_models.ProductOption/page.mdx": "2024-11-27T16:33:56.037Z",
"references/product_models/variables/product_models.ProductOptionValue/page.mdx": "2024-11-27T16:33:56.027Z",
"references/product_models/variables/product_models.ProductTag/page.mdx": "2024-11-27T16:33:56.044Z",
"references/product_models/variables/product_models.ProductType/page.mdx": "2024-11-27T16:33:56.050Z",
"references/product_models/variables/product_models.ProductVariant/page.mdx": "2024-11-27T16:33:56.057Z",
"references/promotion/types/promotion.Constructor/page.mdx": "2024-11-27T16:33:56.374Z",
"references/promotion/types/promotion.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.367Z",
"references/region/types/region.Constructor/page.mdx": "2024-11-27T16:33:56.490Z",
"references/region/types/region.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.483Z",
"references/stock_location_next/types/stock_location_next.Constructor/page.mdx": "2024-11-27T16:33:56.658Z",
"references/stock_location_next/types/stock_location_next.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.602Z",
"references/tax/types/tax.Constructor/page.mdx": "2024-11-27T16:33:56.785Z",
"references/tax/types/tax.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.778Z",
"references/types/DAL/types/types.DAL.InferRepositoryReturnType/page.mdx": "2024-11-27T16:33:39.126Z",
"references/types/DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx": "2024-11-27T16:33:39.164Z",
"references/types/types/types.FilterQueryProperties/page.mdx": "2024-11-27T16:33:39.159Z",
"references/cart/types/cart.FilterQuery/page.mdx": "2024-11-27T16:33:41.056Z",
"references/currency_models/variables/currency_models.Currency/page.mdx": "2024-11-27T16:33:52.164Z",
"references/customer/types/customer.FilterQuery/page.mdx": "2024-11-27T16:33:52.327Z",
"references/fulfillment/types/fulfillment.FilterQuery/page.mdx": "2024-11-27T16:33:52.465Z",
"references/inventory_next/types/inventory_next.FilterQuery/page.mdx": "2024-11-27T16:33:52.961Z",
"references/order/types/order.FilterQuery/page.mdx": "2024-11-27T16:33:54.929Z",
"references/payment/types/payment.FilterQuery/page.mdx": "2024-11-27T16:33:55.662Z",
"references/pricing/types/pricing.FilterQuery/page.mdx": "2024-11-27T16:33:55.857Z",
"references/product/types/product.FilterQuery/page.mdx": "2024-11-27T16:33:56.089Z",
"references/promotion/types/promotion.FilterQuery/page.mdx": "2024-11-27T16:33:56.368Z",
"references/region/types/region.FilterQuery/page.mdx": "2024-11-27T16:33:56.484Z",
"references/stock_location_next/types/stock_location_next.FilterQuery/page.mdx": "2024-11-27T16:33:56.602Z",
"references/tax/types/tax.FilterQuery/page.mdx": "2024-11-27T16:33:56.778Z",
"references/types/DAL/types/types.DAL.FilterQuery/page.mdx": "2024-11-27T16:33:39.147Z",
"references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2024-11-27T16:33:39.170Z",
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2024-11-27T16:33:39.173Z",
"references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-11-27T16:33:39.153Z",
"app/events-reference/page.mdx": "2024-11-27T13:31:07.385Z"
}
www/apps/resources/generated/files-map.mjs
+138 -18
View File
@@ -1143,6 +1143,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/api_key/types/api_key.ApiKeyType/page.mdx",
"pathname": "/references/api_key/types/api_key.ApiKeyType"
},
{
"filePath": "/www/apps/resources/references/api_key/types/api_key.Constructor/page.mdx",
"pathname": "/references/api_key/types/api_key.Constructor"
},
{
"filePath": "/www/apps/resources/references/api_key/types/api_key.Event/page.mdx",
"pathname": "/references/api_key/types/api_key.Event"
@@ -1159,6 +1163,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/api_key/types/api_key.FilterQuery/page.mdx",
"pathname": "/references/api_key/types/api_key.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/api_key/types/api_key.FilterQueryProperties/page.mdx",
"pathname": "/references/api_key/types/api_key.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/api_key/types/api_key.FilterValue/page.mdx",
"pathname": "/references/api_key/types/api_key.FilterValue"
@@ -1887,6 +1895,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart/types/cart.BigNumberValue/page.mdx",
"pathname": "/references/cart/types/cart.BigNumberValue"
},
{
"filePath": "/www/apps/resources/references/cart/types/cart.Constructor/page.mdx",
"pathname": "/references/cart/types/cart.Constructor"
},
{
"filePath": "/www/apps/resources/references/cart/types/cart.Event/page.mdx",
"pathname": "/references/cart/types/cart.Event"
@@ -1903,6 +1915,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart/types/cart.FilterQuery/page.mdx",
"pathname": "/references/cart/types/cart.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/cart/types/cart.FilterQueryProperties/page.mdx",
"pathname": "/references/cart/types/cart.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/cart/types/cart.FilterValue/page.mdx",
"pathname": "/references/cart/types/cart.FilterValue"
@@ -7739,6 +7755,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx",
"pathname": "/references/customer/interfaces/customer.UpdateCustomerAddressDTO"
},
{
"filePath": "/www/apps/resources/references/customer/types/customer.Constructor/page.mdx",
"pathname": "/references/customer/types/customer.Constructor"
},
{
"filePath": "/www/apps/resources/references/customer/types/customer.Event/page.mdx",
"pathname": "/references/customer/types/customer.Event"
@@ -7755,6 +7775,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/customer/types/customer.FilterQuery/page.mdx",
"pathname": "/references/customer/types/customer.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/customer/types/customer.FilterQueryProperties/page.mdx",
"pathname": "/references/customer/types/customer.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/customer/types/customer.FilterValue/page.mdx",
"pathname": "/references/customer/types/customer.FilterValue"
@@ -8619,6 +8643,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.ChangeActionType/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.ChangeActionType"
},
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.Constructor/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.Constructor"
},
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.CreateGeoZoneDTO/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.CreateGeoZoneDTO"
@@ -8639,6 +8667,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.FilterQuery/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.FilterQueryProperties/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.FilterValue/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.FilterValue"
@@ -9147,6 +9179,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.BigNumberRawValue/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.BigNumberRawValue"
},
{
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.Constructor/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.Constructor"
},
{
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.Event/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.Event"
@@ -9163,6 +9199,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.FilterQuery/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.FilterQueryProperties/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.FilterValue/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.FilterValue"
@@ -9903,6 +9943,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx",
"pathname": "/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment"
},
{
"filePath": "/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelTransfer/page.mdx",
"pathname": "/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelTransfer"
},
{
"filePath": "/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx",
"pathname": "/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment"
@@ -12467,6 +12511,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/types/order.ClaimReason/page.mdx",
"pathname": "/references/order/types/order.ClaimReason"
},
{
"filePath": "/www/apps/resources/references/order/types/order.Constructor/page.mdx",
"pathname": "/references/order/types/order.Constructor"
},
{
"filePath": "/www/apps/resources/references/order/types/order.Event/page.mdx",
"pathname": "/references/order/types/order.Event"
@@ -12483,6 +12531,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/types/order.FilterQuery/page.mdx",
"pathname": "/references/order/types/order.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/order/types/order.FilterQueryProperties/page.mdx",
"pathname": "/references/order/types/order.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/order/types/order.FilterValue/page.mdx",
"pathname": "/references/order/types/order.FilterValue"
@@ -12995,6 +13047,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/payment/types/payment.BigNumberValue/page.mdx",
"pathname": "/references/payment/types/payment.BigNumberValue"
},
{
"filePath": "/www/apps/resources/references/payment/types/payment.Constructor/page.mdx",
"pathname": "/references/payment/types/payment.Constructor"
},
{
"filePath": "/www/apps/resources/references/payment/types/payment.Event/page.mdx",
"pathname": "/references/payment/types/payment.Event"
@@ -13011,6 +13067,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/payment/types/payment.FilterQuery/page.mdx",
"pathname": "/references/payment/types/payment.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/payment/types/payment.FilterQueryProperties/page.mdx",
"pathname": "/references/payment/types/payment.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/payment/types/payment.FilterValue/page.mdx",
"pathname": "/references/payment/types/payment.FilterValue"
@@ -13543,6 +13603,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/types/pricing.BigNumberValue/page.mdx",
"pathname": "/references/pricing/types/pricing.BigNumberValue"
},
{
"filePath": "/www/apps/resources/references/pricing/types/pricing.Constructor/page.mdx",
"pathname": "/references/pricing/types/pricing.Constructor"
},
{
"filePath": "/www/apps/resources/references/pricing/types/pricing.Event/page.mdx",
"pathname": "/references/pricing/types/pricing.Event"
@@ -13559,6 +13623,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/types/pricing.FilterQuery/page.mdx",
"pathname": "/references/pricing/types/pricing.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/pricing/types/pricing.FilterQueryProperties/page.mdx",
"pathname": "/references/pricing/types/pricing.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/pricing/types/pricing.FilterValue/page.mdx",
"pathname": "/references/pricing/types/pricing.FilterValue"
@@ -14163,6 +14231,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product/interfaces/product.UpsertProductVariantDTO/page.mdx",
"pathname": "/references/product/interfaces/product.UpsertProductVariantDTO"
},
{
"filePath": "/www/apps/resources/references/product/types/product.Constructor/page.mdx",
"pathname": "/references/product/types/product.Constructor"
},
{
"filePath": "/www/apps/resources/references/product/types/product.Event/page.mdx",
"pathname": "/references/product/types/product.Event"
@@ -14179,6 +14251,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product/types/product.FilterQuery/page.mdx",
"pathname": "/references/product/types/product.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/product/types/product.FilterQueryProperties/page.mdx",
"pathname": "/references/product/types/product.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/product/types/product.FilterValue/page.mdx",
"pathname": "/references/product/types/product.FilterValue"
@@ -14248,40 +14324,40 @@ export const filesMap = [
"pathname": "/references/product/types/product.Scalar"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.Image/page.mdx",
"pathname": "/references/product_models/classes/product_models.Image"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Image/page.mdx",
"pathname": "/references/product_models/variables/product_models.Image"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.Product/page.mdx",
"pathname": "/references/product_models/classes/product_models.Product"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Product/page.mdx",
"pathname": "/references/product_models/variables/product_models.Product"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductCategory/page.mdx",
"pathname": "/references/product_models/classes/product_models.ProductCategory"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCategory/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductCategory"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductCollection/page.mdx",
"pathname": "/references/product_models/classes/product_models.ProductCollection"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductCollection"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductOption/page.mdx",
"pathname": "/references/product_models/classes/product_models.ProductOption"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOption/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductOption"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductOptionValue/page.mdx",
"pathname": "/references/product_models/classes/product_models.ProductOptionValue"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOptionValue/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductOptionValue"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductTag/page.mdx",
"pathname": "/references/product_models/classes/product_models.ProductTag"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductTag/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductTag"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductType/page.mdx",
"pathname": "/references/product_models/classes/product_models.ProductType"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductType/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductType"
},
{
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductVariant/page.mdx",
"pathname": "/references/product_models/classes/product_models.ProductVariant"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductVariant/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductVariant"
},
{
"filePath": "/www/apps/resources/references/promotion/IBigNumber/methods/promotion.IBigNumber.toJSON/page.mdx",
@@ -14623,6 +14699,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/promotion/types/promotion.ComputeActions/page.mdx",
"pathname": "/references/promotion/types/promotion.ComputeActions"
},
{
"filePath": "/www/apps/resources/references/promotion/types/promotion.Constructor/page.mdx",
"pathname": "/references/promotion/types/promotion.Constructor"
},
{
"filePath": "/www/apps/resources/references/promotion/types/promotion.Event/page.mdx",
"pathname": "/references/promotion/types/promotion.Event"
@@ -14639,6 +14719,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/promotion/types/promotion.FilterQuery/page.mdx",
"pathname": "/references/promotion/types/promotion.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/promotion/types/promotion.FilterQueryProperties/page.mdx",
"pathname": "/references/promotion/types/promotion.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/promotion/types/promotion.FilterValue/page.mdx",
"pathname": "/references/promotion/types/promotion.FilterValue"
@@ -14879,6 +14963,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/region/interfaces/region.UpsertRegionDTO/page.mdx",
"pathname": "/references/region/interfaces/region.UpsertRegionDTO"
},
{
"filePath": "/www/apps/resources/references/region/types/region.Constructor/page.mdx",
"pathname": "/references/region/types/region.Constructor"
},
{
"filePath": "/www/apps/resources/references/region/types/region.Event/page.mdx",
"pathname": "/references/region/types/region.Event"
@@ -14895,6 +14983,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/region/types/region.FilterQuery/page.mdx",
"pathname": "/references/region/types/region.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/region/types/region.FilterQueryProperties/page.mdx",
"pathname": "/references/region/types/region.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/region/types/region.FilterValue/page.mdx",
"pathname": "/references/region/types/region.FilterValue"
@@ -15295,6 +15387,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/stock_location_next/interfaces/stock_location_next.UpsertStockLocationInput/page.mdx",
"pathname": "/references/stock_location_next/interfaces/stock_location_next.UpsertStockLocationInput"
},
{
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.Constructor/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.Constructor"
},
{
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.CreateStockLocationInput/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.CreateStockLocationInput"
@@ -15315,6 +15411,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.FilterQuery/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.FilterQueryProperties/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.FilterValue/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.FilterValue"
@@ -15823,6 +15923,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/tax/types/tax.BigNumberRawValue/page.mdx",
"pathname": "/references/tax/types/tax.BigNumberRawValue"
},
{
"filePath": "/www/apps/resources/references/tax/types/tax.Constructor/page.mdx",
"pathname": "/references/tax/types/tax.Constructor"
},
{
"filePath": "/www/apps/resources/references/tax/types/tax.Event/page.mdx",
"pathname": "/references/tax/types/tax.Event"
@@ -15839,6 +15943,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/tax/types/tax.FilterQuery/page.mdx",
"pathname": "/references/tax/types/tax.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/tax/types/tax.FilterQueryProperties/page.mdx",
"pathname": "/references/tax/types/tax.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/tax/types/tax.FilterValue/page.mdx",
"pathname": "/references/tax/types/tax.FilterValue"
@@ -16111,6 +16219,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/DAL/types/types.DAL.FilterQuery/page.mdx",
"pathname": "/references/types/DAL/types/types.DAL.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/types/DAL/types/types.DAL.InferRepositoryReturnType/page.mdx",
"pathname": "/references/types/DAL/types/types.DAL.InferRepositoryReturnType"
},
{
"filePath": "/www/apps/resources/references/types/DAL/types/types.DAL.ModelDateColumns/page.mdx",
"pathname": "/references/types/DAL/types/types.DAL.ModelDateColumns"
@@ -16199,6 +16311,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.IsNullableRelation"
},
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.KnownDataTypes"
@@ -20507,6 +20623,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.ExtractOrderByOperators/page.mdx",
"pathname": "/references/types/types/types.ExtractOrderByOperators"
},
{
"filePath": "/www/apps/resources/references/types/types/types.FilterQueryProperties/page.mdx",
"pathname": "/references/types/types/types.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/types/types/types.FilterValue/page.mdx",
"pathname": "/references/types/types/types.FilterValue"
www/apps/resources/generated/sidebar.mjs
+1 -1
View File
@@ -5919,7 +5919,7 @@ export const generatedSidebar = [
"type": "category",
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/product_models/classes",
"autogenerate_path": "/references/product_models/variables",
"children": [
{
"loaded": true,
www/apps/resources/generated/slug-changes.mjs
+18 -18
View File
@@ -6085,49 +6085,49 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/product/interfaces/product.IProductModuleService/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.Image",
"origSlug": "/references/product_models/variables/product_models.Image",
"newSlug": "/references/product/models/Image",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.Image/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Image/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.Product",
"origSlug": "/references/product_models/variables/product_models.Product",
"newSlug": "/references/product/models/Product",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.Product/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Product/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductCategory",
"origSlug": "/references/product_models/variables/product_models.ProductCategory",
"newSlug": "/references/product/models/ProductCategory",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductCategory/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCategory/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductCollection",
"origSlug": "/references/product_models/variables/product_models.ProductCollection",
"newSlug": "/references/product/models/ProductCollection",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductCollection/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductOption",
"origSlug": "/references/product_models/variables/product_models.ProductOption",
"newSlug": "/references/product/models/ProductOption",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductOption/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOption/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductOptionValue",
"origSlug": "/references/product_models/variables/product_models.ProductOptionValue",
"newSlug": "/references/product/models/ProductOptionValue",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductOptionValue/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOptionValue/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductTag",
"origSlug": "/references/product_models/variables/product_models.ProductTag",
"newSlug": "/references/product/models/ProductTag",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductTag/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductTag/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductType",
"origSlug": "/references/product_models/variables/product_models.ProductType",
"newSlug": "/references/product/models/ProductType",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductType/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductType/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductVariant",
"origSlug": "/references/product_models/variables/product_models.ProductVariant",
"newSlug": "/references/product/models/ProductVariant",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductVariant/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductVariant/page.mdx"
},
{
"origSlug": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionBuyRules",
www/apps/resources/references/api_key/types/api_key.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: apiKeyReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/api_key/types/api_key.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../api_key.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../api_key.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../api_key.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/api_key/types/api_key.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: apiKeyReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/cart/types/cart.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/cart/types/cart.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../cart.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../cart.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../cart.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/cart/types/cart.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: cartReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/currency_models/variables/currency_models.Currency/page.mdx
+1 -1
View File
@@ -8,6 +8,6 @@ import { TypeList } from "docs-ui"
# Currency - Currency Module Data Models Reference
This documentation provides a reference to the Currency . This belongs to the Currency Module.
This documentation provides a reference to the Currency data model. It belongs to the Currency Module.
<TypeList types={[{"name":"code","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 3-character currency code. For example, `USD`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"The symbol of the currency. For example, `$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"The native symbol of the currency, if it has a different local symbol.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"How many digits are after the decimal separator for prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"The rounding percision of prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Currency"/>
www/apps/resources/references/customer/types/customer.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: customerReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/customer/types/customer.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../customer.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../customer.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../customer.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/customer/types/customer.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: customerReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/dml/Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx
+1 -1
View File
@@ -35,4 +35,4 @@ const Product = model.define("product", {
## Parameters
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ManyToManyOptions](../../../entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo` and `manyToMany`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotTable","type":"`string`","description":"The name of the pivot table\ncreated in the database for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotEntity","type":"() => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any, any&#62;","description":"A function that returns the data model\nrepresenting the pivot table created in the\ndatabase for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="manyToMany"/>
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ManyToManyOptions](../../../entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo` and `manyToMany`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotTable","type":"`string`","description":"The name of the pivot table\ncreated in the database for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"joinColumn","type":"`string`","description":"The column name in the pivot table that for the current entity","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverseJoinColumn","type":"`string`","description":"The column name in the pivot table for the opposite entity","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotEntity","type":"() => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any, any&#62;","description":"A function that returns the data model\nrepresenting the pivot table created in the\ndatabase for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="manyToMany"/>
www/apps/resources/references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx
+16
View File
@@ -23,6 +23,22 @@ created in the database for this relationship.
___
## joinColumn
`Optional` **joinColumn**: `string`
The column name in the pivot table that for the current entity
___
## inverseJoinColumn
`Optional` **inverseJoinColumn**: `string`
The column name in the pivot table for the opposite entity
___
## pivotEntity
`Optional` **pivotEntity**: () => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any, any&#62;
www/apps/resources/references/fulfillment/types/fulfillment.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/fulfillment/types/fulfillment.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../fulfillment.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../fulfillment.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../fulfillment.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/fulfillment/types/fulfillment.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/inventory_next/types/inventory_next.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: inventoryNextReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/inventory_next/types/inventory_next.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../inventory_next.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../inventory_next.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../inventory_next.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/inventory_next/types/inventory_next.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: inventoryNextReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx
+25
View File
@@ -180,6 +180,31 @@ sdk.admin.order.requestTransfer("order_123", {
___
## cancelTransfer
This method cancels an order transfer request. It sends a request to the
[Cancel Order Transfer Request](https://docs.medusajs.com/api/admin#orders\_postordersidcanceltransferrequest)
API route.
### Example
```ts
sdk.admin.order.cancelTransfer("order_123")
.then(({ order }) => {
console.log(order)
})
```
### Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelTransfer"/>
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The order's details.","expandable":false,"children":[{"name":"AdminOrderResponse","type":"[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order","type":"[AdminOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx)[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx)[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxes and promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`number`","description":"The tax total applied on the order's items, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`number`","description":"The total of the order including taxes, excluding promotions.","optional":false,"defaLine truncated
___
## createFulfillment
This method creates a fulfillment for an order. It sends a request to the
www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelTransfer/page.mdx
+24
View File
@@ -0,0 +1,24 @@
import { TypeList } from "docs-ui"
# cancelTransfer
This method cancels an order transfer request. It sends a request to the
[Cancel Order Transfer Request](https://docs.medusajs.com/api/admin#orders\_postordersidcanceltransferrequest)
API route.
## Example
```ts
sdk.admin.order.cancelTransfer("order_123")
.then(({ order }) => {
console.log(order)
})
```
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelTransfer"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The order's details.","expandable":false,"children":[{"name":"AdminOrderResponse","type":"[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order","type":"[AdminOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx)[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx)[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxes and promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`number`","description":"The tax total applied on the order's items, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`number`","description":"The total of the order including taxes, excluding promotions.","optional":false,"defaLine truncated
www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx
+1
View File
@@ -6,6 +6,7 @@ import { TypeList } from "docs-ui"
- [cancel](../../Order/methods/js_sdk.admin.Order.cancel/page.mdx)
- [cancelFulfillment](../../Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx)
- [cancelTransfer](../../Order/methods/js_sdk.admin.Order.cancelTransfer/page.mdx)
- [createFulfillment](../../Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx)
- [createShipment](../../Order/methods/js_sdk.admin.Order.createShipment/page.mdx)
- [list](../../Order/methods/js_sdk.admin.Order.list/page.mdx)
www/apps/resources/references/modules/api_key/page.mdx
+2
View File
@@ -23,10 +23,12 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [ApiKeyType](../../api_key/types/api_key.ApiKeyType/page.mdx)
- [Constructor](../../api_key/types/api_key.Constructor/page.mdx)
- [Event](../../api_key/types/api_key.Event/page.mdx)
- [EventMetadata](../../api_key/types/api_key.EventMetadata/page.mdx)
- [ExpandScalar](../../api_key/types/api_key.ExpandScalar/page.mdx)
- [FilterQuery](../../api_key/types/api_key.FilterQuery/page.mdx)
- [FilterQueryProperties](../../api_key/types/api_key.FilterQueryProperties/page.mdx)
- [FilterValue](../../api_key/types/api_key.FilterValue/page.mdx)
- [FilterValue2](../../api_key/types/api_key.FilterValue2/page.mdx)
- [FindConfigOrder](../../api_key/types/api_key.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/cart/page.mdx
+2
View File
@@ -65,10 +65,12 @@ import { TypeList } from "docs-ui"
- [BigNumberInput](../../cart/types/cart.BigNumberInput/page.mdx)
- [BigNumberRawValue](../../cart/types/cart.BigNumberRawValue/page.mdx)
- [BigNumberValue](../../cart/types/cart.BigNumberValue/page.mdx)
- [Constructor](../../cart/types/cart.Constructor/page.mdx)
- [Event](../../cart/types/cart.Event/page.mdx)
- [EventMetadata](../../cart/types/cart.EventMetadata/page.mdx)
- [ExpandScalar](../../cart/types/cart.ExpandScalar/page.mdx)
- [FilterQuery](../../cart/types/cart.FilterQuery/page.mdx)
- [FilterQueryProperties](../../cart/types/cart.FilterQueryProperties/page.mdx)
- [FilterValue](../../cart/types/cart.FilterValue/page.mdx)
- [FilterValue2](../../cart/types/cart.FilterValue2/page.mdx)
- [FindConfigOrder](../../cart/types/cart.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/customer/page.mdx
+2
View File
@@ -33,10 +33,12 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [Constructor](../../customer/types/customer.Constructor/page.mdx)
- [Event](../../customer/types/customer.Event/page.mdx)
- [EventMetadata](../../customer/types/customer.EventMetadata/page.mdx)
- [ExpandScalar](../../customer/types/customer.ExpandScalar/page.mdx)
- [FilterQuery](../../customer/types/customer.FilterQuery/page.mdx)
- [FilterQueryProperties](../../customer/types/customer.FilterQueryProperties/page.mdx)
- [FilterValue](../../customer/types/customer.FilterValue/page.mdx)
- [FilterValue2](../../customer/types/customer.FilterValue2/page.mdx)
- [FindConfigOrder](../../customer/types/customer.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/fulfillment/page.mdx
+2
View File
@@ -93,11 +93,13 @@ import { TypeList } from "docs-ui"
- [BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)
- [BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)
- [ChangeActionType](../../fulfillment/types/fulfillment.ChangeActionType/page.mdx)
- [Constructor](../../fulfillment/types/fulfillment.Constructor/page.mdx)
- [CreateGeoZoneDTO](../../fulfillment/types/fulfillment.CreateGeoZoneDTO/page.mdx)
- [Event](../../fulfillment/types/fulfillment.Event/page.mdx)
- [EventMetadata](../../fulfillment/types/fulfillment.EventMetadata/page.mdx)
- [ExpandScalar](../../fulfillment/types/fulfillment.ExpandScalar/page.mdx)
- [FilterQuery](../../fulfillment/types/fulfillment.FilterQuery/page.mdx)
- [FilterQueryProperties](../../fulfillment/types/fulfillment.FilterQueryProperties/page.mdx)
- [FilterValue](../../fulfillment/types/fulfillment.FilterValue/page.mdx)
- [FilterValue2](../../fulfillment/types/fulfillment.FilterValue2/page.mdx)
- [FindConfigOrder](../../fulfillment/types/fulfillment.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/inventory_next/page.mdx
+2
View File
@@ -35,10 +35,12 @@ import { TypeList } from "docs-ui"
- [BigNumberInput](../../inventory_next/types/inventory_next.BigNumberInput/page.mdx)
- [BigNumberRawValue](../../inventory_next/types/inventory_next.BigNumberRawValue/page.mdx)
- [Constructor](../../inventory_next/types/inventory_next.Constructor/page.mdx)
- [Event](../../inventory_next/types/inventory_next.Event/page.mdx)
- [EventMetadata](../../inventory_next/types/inventory_next.EventMetadata/page.mdx)
- [ExpandScalar](../../inventory_next/types/inventory_next.ExpandScalar/page.mdx)
- [FilterQuery](../../inventory_next/types/inventory_next.FilterQuery/page.mdx)
- [FilterQueryProperties](../../inventory_next/types/inventory_next.FilterQueryProperties/page.mdx)
- [FilterValue](../../inventory_next/types/inventory_next.FilterValue/page.mdx)
- [FilterValue2](../../inventory_next/types/inventory_next.FilterValue2/page.mdx)
- [FindConfigOrder](../../inventory_next/types/inventory_next.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/order/page.mdx
+2
View File
@@ -120,10 +120,12 @@ import { TypeList } from "docs-ui"
- [BigNumberValue](../../order/types/order.BigNumberValue/page.mdx)
- [ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)
- [ClaimReason](../../order/types/order.ClaimReason/page.mdx)
- [Constructor](../../order/types/order.Constructor/page.mdx)
- [Event](../../order/types/order.Event/page.mdx)
- [EventMetadata](../../order/types/order.EventMetadata/page.mdx)
- [ExpandScalar](../../order/types/order.ExpandScalar/page.mdx)
- [FilterQuery](../../order/types/order.FilterQuery/page.mdx)
- [FilterQueryProperties](../../order/types/order.FilterQueryProperties/page.mdx)
- [FilterValue](../../order/types/order.FilterValue/page.mdx)
- [FilterValue2](../../order/types/order.FilterValue2/page.mdx)
- [FindConfigOrder](../../order/types/order.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/payment/page.mdx
+2
View File
@@ -54,10 +54,12 @@ import { TypeList } from "docs-ui"
- [BigNumberInput](../../payment/types/payment.BigNumberInput/page.mdx)
- [BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)
- [BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)
- [Constructor](../../payment/types/payment.Constructor/page.mdx)
- [Event](../../payment/types/payment.Event/page.mdx)
- [EventMetadata](../../payment/types/payment.EventMetadata/page.mdx)
- [ExpandScalar](../../payment/types/payment.ExpandScalar/page.mdx)
- [FilterQuery](../../payment/types/payment.FilterQuery/page.mdx)
- [FilterQueryProperties](../../payment/types/payment.FilterQueryProperties/page.mdx)
- [FilterValue](../../payment/types/payment.FilterValue/page.mdx)
- [FilterValue2](../../payment/types/payment.FilterValue2/page.mdx)
- [FindConfigOrder](../../payment/types/payment.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/pricing/page.mdx
+2
View File
@@ -62,10 +62,12 @@ import { TypeList } from "docs-ui"
- [BigNumberInput](../../pricing/types/pricing.BigNumberInput/page.mdx)
- [BigNumberRawValue](../../pricing/types/pricing.BigNumberRawValue/page.mdx)
- [BigNumberValue](../../pricing/types/pricing.BigNumberValue/page.mdx)
- [Constructor](../../pricing/types/pricing.Constructor/page.mdx)
- [Event](../../pricing/types/pricing.Event/page.mdx)
- [EventMetadata](../../pricing/types/pricing.EventMetadata/page.mdx)
- [ExpandScalar](../../pricing/types/pricing.ExpandScalar/page.mdx)
- [FilterQuery](../../pricing/types/pricing.FilterQuery/page.mdx)
- [FilterQueryProperties](../../pricing/types/pricing.FilterQueryProperties/page.mdx)
- [FilterValue](../../pricing/types/pricing.FilterValue/page.mdx)
- [FilterValue2](../../pricing/types/pricing.FilterValue2/page.mdx)
- [FindConfigOrder](../../pricing/types/pricing.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/product/page.mdx
+2
View File
@@ -60,10 +60,12 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [Constructor](../../product/types/product.Constructor/page.mdx)
- [Event](../../product/types/product.Event/page.mdx)
- [EventMetadata](../../product/types/product.EventMetadata/page.mdx)
- [ExpandScalar](../../product/types/product.ExpandScalar/page.mdx)
- [FilterQuery](../../product/types/product.FilterQuery/page.mdx)
- [FilterQueryProperties](../../product/types/product.FilterQueryProperties/page.mdx)
- [FilterValue](../../product/types/product.FilterValue/page.mdx)
- [FilterValue2](../../product/types/product.FilterValue2/page.mdx)
- [FindConfigOrder](../../product/types/product.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/product_models/page.mdx
+13 -14
View File
@@ -13,27 +13,26 @@ This documentation provides a reference to the data models in the Product Module
```mermaid
erDiagram
Product ||--|| ProductOption : options
Product ||--|| ProductVariant : variants
Product }|--|{ ProductCollection : collection
Product }|--|{ ProductType : type
Product }|--|{ ProductTag : tags
Product ||--|| ProductOption : options
Product ||--|| Image : images
Product }|--|{ ProductCategory : categories
ProductCategory }|--|{ ProductCategory : parent_category
ProductCollection ||--|| Product : products
ProductOption ||--|| ProductOptionValue : values
ProductOptionValue }|--|{ ProductVariant : variants
ProductType ||--|| Product : product
```
## Classes
## Data Models
- [Image](../../product_models/classes/product_models.Image/page.mdx)
- [Product](../../product_models/classes/product_models.Product/page.mdx)
- [ProductCategory](../../product_models/classes/product_models.ProductCategory/page.mdx)
- [ProductCollection](../../product_models/classes/product_models.ProductCollection/page.mdx)
- [ProductOption](../../product_models/classes/product_models.ProductOption/page.mdx)
- [ProductOptionValue](../../product_models/classes/product_models.ProductOptionValue/page.mdx)
- [ProductTag](../../product_models/classes/product_models.ProductTag/page.mdx)
- [ProductType](../../product_models/classes/product_models.ProductType/page.mdx)
- [ProductVariant](../../product_models/classes/product_models.ProductVariant/page.mdx)
- [Image](../../product_models/variables/product_models.Image/page.mdx)
- [Product](../../product_models/variables/product_models.Product/page.mdx)
- [ProductCategory](../../product_models/variables/product_models.ProductCategory/page.mdx)
- [ProductCollection](../../product_models/variables/product_models.ProductCollection/page.mdx)
- [ProductOption](../../product_models/variables/product_models.ProductOption/page.mdx)
- [ProductOptionValue](../../product_models/variables/product_models.ProductOptionValue/page.mdx)
- [ProductTag](../../product_models/variables/product_models.ProductTag/page.mdx)
- [ProductType](../../product_models/variables/product_models.ProductType/page.mdx)
- [ProductVariant](../../product_models/variables/product_models.ProductVariant/page.mdx)
www/apps/resources/references/modules/promotion/page.mdx
+2
View File
@@ -56,10 +56,12 @@ import { TypeList } from "docs-ui"
- [BigNumberRawValue](../../promotion/types/promotion.BigNumberRawValue/page.mdx)
- [CampaignBudgetTypeValues](../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)
- [ComputeActions](../../promotion/types/promotion.ComputeActions/page.mdx)
- [Constructor](../../promotion/types/promotion.Constructor/page.mdx)
- [Event](../../promotion/types/promotion.Event/page.mdx)
- [EventMetadata](../../promotion/types/promotion.EventMetadata/page.mdx)
- [ExpandScalar](../../promotion/types/promotion.ExpandScalar/page.mdx)
- [FilterQuery](../../promotion/types/promotion.FilterQuery/page.mdx)
- [FilterQueryProperties](../../promotion/types/promotion.FilterQueryProperties/page.mdx)
- [FilterValue](../../promotion/types/promotion.FilterValue/page.mdx)
- [FilterValue2](../../promotion/types/promotion.FilterValue2/page.mdx)
- [FindConfigOrder](../../promotion/types/promotion.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/region/page.mdx
+2
View File
@@ -26,10 +26,12 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [Constructor](../../region/types/region.Constructor/page.mdx)
- [Event](../../region/types/region.Event/page.mdx)
- [EventMetadata](../../region/types/region.EventMetadata/page.mdx)
- [ExpandScalar](../../region/types/region.ExpandScalar/page.mdx)
- [FilterQuery](../../region/types/region.FilterQuery/page.mdx)
- [FilterQueryProperties](../../region/types/region.FilterQueryProperties/page.mdx)
- [FilterValue](../../region/types/region.FilterValue/page.mdx)
- [FilterValue2](../../region/types/region.FilterValue2/page.mdx)
- [FindConfigOrder](../../region/types/region.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/stock_location_next/page.mdx
+2
View File
@@ -32,11 +32,13 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [Constructor](../../stock_location_next/types/stock_location_next.Constructor/page.mdx)
- [CreateStockLocationInput](../../stock_location_next/types/stock_location_next.CreateStockLocationInput/page.mdx)
- [Event](../../stock_location_next/types/stock_location_next.Event/page.mdx)
- [EventMetadata](../../stock_location_next/types/stock_location_next.EventMetadata/page.mdx)
- [ExpandScalar](../../stock_location_next/types/stock_location_next.ExpandScalar/page.mdx)
- [FilterQuery](../../stock_location_next/types/stock_location_next.FilterQuery/page.mdx)
- [FilterQueryProperties](../../stock_location_next/types/stock_location_next.FilterQueryProperties/page.mdx)
- [FilterValue](../../stock_location_next/types/stock_location_next.FilterValue/page.mdx)
- [FilterValue2](../../stock_location_next/types/stock_location_next.FilterValue2/page.mdx)
- [FindConfigOrder](../../stock_location_next/types/stock_location_next.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/tax/page.mdx
+2
View File
@@ -39,10 +39,12 @@ import { TypeList } from "docs-ui"
- [BigNumberInput](../../tax/types/tax.BigNumberInput/page.mdx)
- [BigNumberRawValue](../../tax/types/tax.BigNumberRawValue/page.mdx)
- [Constructor](../../tax/types/tax.Constructor/page.mdx)
- [Event](../../tax/types/tax.Event/page.mdx)
- [EventMetadata](../../tax/types/tax.EventMetadata/page.mdx)
- [ExpandScalar](../../tax/types/tax.ExpandScalar/page.mdx)
- [FilterQuery](../../tax/types/tax.FilterQuery/page.mdx)
- [FilterQueryProperties](../../tax/types/tax.FilterQueryProperties/page.mdx)
- [FilterValue](../../tax/types/tax.FilterValue/page.mdx)
- [FilterValue2](../../tax/types/tax.FilterValue2/page.mdx)
- [FindConfigOrder](../../tax/types/tax.FindConfigOrder/page.mdx)
www/apps/resources/references/modules/types/page.mdx
+1
View File
@@ -250,6 +250,7 @@ import { TypeList } from "docs-ui"
- [ExtractFiltersOperators](../../types/types/types.ExtractFiltersOperators/page.mdx)
- [ExtractFiltersOperators](../../types/types/types.ExtractFiltersOperators-1/page.mdx)
- [ExtractOrderByOperators](../../types/types/types.ExtractOrderByOperators/page.mdx)
- [FilterQueryProperties](../../types/types/types.FilterQueryProperties/page.mdx)
- [FilterValue](../../types/types/types.FilterValue/page.mdx)
- [FilterValue2](../../types/types/types.FilterValue2/page.mdx)
- [FlowRunOptions](../../types/types/types.FlowRunOptions/page.mdx)
www/apps/resources/references/order/types/order.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/order/types/order.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../order.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../order.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../order.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/order/types/order.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/payment/types/payment.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/payment/types/payment.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../payment.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../payment.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../payment.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/payment/types/payment.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: paymentReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/pricing/types/pricing.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/pricing/types/pricing.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../pricing.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../pricing.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../pricing.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/pricing/types/pricing.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/product/types/product.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/product/types/product.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../product.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../product.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../product.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/product/types/product.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: productReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/product_models/classes/product_models.Image/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/Image
sidebar_label: Image
---
import { TypeList } from "docs-ui"
# Image - Product Module Data Models Reference
This documentation provides a reference to the Image . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"Collection&#60;[ProductVariant](../product_models.ProductVariant/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expanLine truncated
www/apps/resources/references/product_models/classes/product_models.Product/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/Product
sidebar_label: Product
---
import { TypeList } from "docs-ui"
# Product - Product Module Data Models Reference
This documentation provides a reference to the Product . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"Collection&#60;[ProductVariant](../product_models.ProductVariant/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollection](../product_models.ProductCollection/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductType](../product_models.ProductType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"Collection&#60;[ProductTag](../product_models.ProductTag/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[Image](../product_models.Image/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"Collection&#60;[ProductCategory](../product_models.ProductCategory/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":Line truncated
www/apps/resources/references/product_models/classes/product_models.ProductCategory/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductCategory
sidebar_label: ProductCategory
---
import { TypeList } from "docs-ui"
# ProductCategory - Product Module Data Models Reference
This documentation provides a reference to the ProductCategory . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"Collection&#60;[ProductCategory](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"Collection&#60;[ProductCategory](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"Collection&#60;[ProductCategory](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"products","type":"Collection&#60;[Product](../product_models.Product/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mpath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"[ProductCategory](page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"products","type":"Collection&#60;[Product](../product_models.Product/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"Collection&#60;[ProductVariant](../product_models.ProductVariant/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollection](../product_models.ProductCollection/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductType](../product_models.ProductType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"Collection&#60;[ProductTag](../prodLine truncated
www/apps/resources/references/product_models/classes/product_models.ProductCollection/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductCollection
sidebar_label: ProductCollection
---
import { TypeList } from "docs-ui"
# ProductCollection - Product Module Data Models Reference
This documentation provides a reference to the ProductCollection . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"Collection&#60;[Product](../product_models.Product/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"Collection&#60;[ProductVariant](../product_models.ProductVariant/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":true,"defaultValue":"false","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"","optional":true,"defaultValue":"true","expandable":false,"children":[]},{"name":"hs_code","type":"`null` Line truncated
www/apps/resources/references/product_models/classes/product_models.ProductOption/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductOption
sidebar_label: ProductOption
---
import { TypeList } from "docs-ui"
# ProductOption - Product Module Data Models Reference
This documentation provides a reference to the ProductOption . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"Collection&#60;[ProductOption](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"Collection&#60;[ProductVariant](../product_models.ProductVariant/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":true,"defaultValue":"false","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"","optional":true,"deLine truncated
www/apps/resources/references/product_models/classes/product_models.ProductOptionValue/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductOptionValue
sidebar_label: ProductOptionValue
---
import { TypeList } from "docs-ui"
# ProductOptionValue - Product Module Data Models Reference
This documentation provides a reference to the ProductOptionValue . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOption](../product_models.ProductOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"Collection&#60;[ProductVariant](../product_models.ProductVariant/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollection](../product_models.ProductCollection/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductType](../product_models.ProductType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"Collection&#60;[ProductTag](../product_models.ProductTag/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[Image](../product_models.Image/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"Collection&#60;[ProductCategory](../product_models.ProductCategory/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"midLine truncated
www/apps/resources/references/product_models/classes/product_models.ProductTag/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductTag
sidebar_label: ProductTag
---
import { TypeList } from "docs-ui"
# ProductTag - Product Module Data Models Reference
This documentation provides a reference to the ProductTag . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"Collection&#60;[Product](../product_models.Product/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"Collection&#60;[ProductVariant](../product_models.ProductVariant/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","descriptionLine truncated
www/apps/resources/references/product_models/classes/product_models.ProductType/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductType
sidebar_label: ProductType
---
import { TypeList } from "docs-ui"
# ProductType - Product Module Data Models Reference
This documentation provides a reference to the ProductType . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductType"/>
www/apps/resources/references/product_models/classes/product_models.ProductVariant/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductVariant
sidebar_label: ProductVariant
---
import { TypeList } from "docs-ui"
# ProductVariant - Product Module Data Models Reference
This documentation provides a reference to the ProductVariant . This belongs to the Product Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"Collection&#60;[ProductOption](../product_models.ProductOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"Collection&#60;[ProductVariant](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [Product](../product_models.Product/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"Collection&#60;[ProductOptionValue](../product_models.ProductOptionValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":true,"defaultValue":"false","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"","optional":true,"defLine truncated
www/apps/resources/references/product_models/variables/product_models.Image/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/Image
sidebar_label: Image
---
import { TypeList } from "docs-ui"
# Image - Product Module Data Models Reference
This documentation provides a reference to the Image data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`NumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"BelongsTo&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?:Line truncated
www/apps/resources/references/product_models/variables/product_models.Product/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/Product
sidebar_label: Product
---
import { TypeList } from "docs-ui"
# Product - Product Module Data Models Reference
This documentation provides a reference to the Product data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62Line truncated
www/apps/resources/references/product_models/variables/product_models.ProductCategory/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductCategory
sidebar_label: ProductCategory
---
import { TypeList } from "docs-ui"
# ProductCategory - Product Module Data Models Reference
This documentation provides a reference to the ProductCategory data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mpath","type":"`TextProperty`","description":"The mpath of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`BooleanProperty`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`BooleanProperty`","description":"Whether the product category is internal, meaning it's only available for admin users.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`NumberProperty`","description":"The rank of the product category among its siblings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"RelationNullableModifier&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">, BelongsTo&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">&#62;&#62;","description":"The associated parent\\_category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"category_children","type":"HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">&#62;","description":"The associated category\\_children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"ManyToMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle:Line truncated
www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductCollection
sidebar_label: ProductCollection
---
import { TypeList } from "docs-ui"
# ProductCollection - Product Module Data Models Reference
This documentation provides a reference to the ProductCollection data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"HasMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thuLine truncated
www/apps/resources/references/product_models/variables/product_models.ProductOption/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductOption
sidebar_label: ProductOption
---
import { TypeList } from "docs-ui"
# ProductOption - Product Module Data Models Reference
This documentation provides a reference to the ProductOption data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"BelongsTo&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated product.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mLine truncated
www/apps/resources/references/product_models/variables/product_models.ProductOptionValue/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductOptionValue
sidebar_label: ProductOptionValue
---
import { TypeList } from "docs-ui"
# ProductOptionValue - Product Module Data Models Reference
This documentation provides a reference to the ProductOptionValue data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; metadata?: JSONProperty ; product: BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; values: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; value: TextProperty; metadata: NullableModifier<Record<string, unknown>, JSONProperty>; option: RelationNullableModifier<...>; variants: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductOptionValue\">&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; metadata?: JSONProperty ; product: BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; values: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; value: TextProperty; metadata: NullableModifier<Record<string, unknown>, JSONProperty>; option: RelationNullableModifier<...>; variants: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductOptionValue\">&#62; &#125; & {} & DMLSchemaDefaults, \"ProductOption\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; metadata?: JSONProperty ; product: BelongsTo&#60;() => ...&#62; ; values: HasMany&#60;() => ...&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; metadata?: JSONProperty ; product: BelongsTo&#60;() => ...&#62; ; values: HasMany&#60;() => ...&#62; &#125; & {} & DMLSchemaDefaults, \"ProductOption\"&#62;&#62;&#62;","description":"The associated option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"ManyToMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categorLine truncated
www/apps/resources/references/product_models/variables/product_models.ProductTag/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductTag
sidebar_label: ProductTag
---
import { TypeList } from "docs-ui"
# ProductTag - Product Module Data Models Reference
This documentation provides a reference to the ProductTag data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the product tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"ManyToMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_cLine truncated
www/apps/resources/references/product_models/variables/product_models.ProductType/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductType
sidebar_label: ProductType
---
import { TypeList } from "docs-ui"
# ProductType - Product Module Data Models Reference
This documentation provides a reference to the ProductType data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the product type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"HasMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated product.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_codeLine truncated
www/apps/resources/references/product_models/variables/product_models.ProductVariant/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductVariant
sidebar_label: ProductVariant
---
import { TypeList } from "docs-ui"
# ProductVariant - Product Module Data Models Reference
This documentation provides a reference to the ProductVariant data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & {} & DMLSchemaDefaults, \"Product\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty Line truncated
www/apps/resources/references/promotion/types/promotion.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: promotionReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/promotion/types/promotion.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../promotion.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../promotion.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../promotion.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/promotion/types/promotion.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: promotionReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/region/types/region.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: regionReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/region/types/region.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../region.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../region.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../region.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/region/types/region.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: regionReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/region_models/variables/region_models.Country/page.mdx
+1 -1
View File
@@ -8,6 +8,6 @@ import { TypeList } from "docs-ui"
# Country - Region Module Data Models Reference
This documentation provides a reference to the Country . This belongs to the Region Module.
This documentation provides a reference to the Country data model. It belongs to the Region Module.
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;&#62;&#62;","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Country"/>
www/apps/resources/references/region_models/variables/region_models.Region/page.mdx
+1 -1
View File
@@ -8,6 +8,6 @@ import { TypeList } from "docs-ui"
# Region - Region Module Data Models Reference
This documentation provides a reference to the Region . This belongs to the Region Module.
This documentation provides a reference to the Region data model. It belongs to the Region Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](../region_models.Country/page.mdx)&#62;","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;&#62;&#62;","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Region"/>
www/apps/resources/references/stock_location_next/types/stock_location_next.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: stockLocationNextReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/stock_location_next/types/stock_location_next.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../stock_location_next.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../stock_location_next.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../stock_location_next.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/stock_location_next/types/stock_location_next.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: stockLocationNextReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/tax/types/tax.Constructor/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: taxReference
---
import { TypeList } from "docs-ui"
# Constructor
**Constructor**: (...`args`: `any`[]) => T \| () => T
## Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
www/apps/resources/references/tax/types/tax.FilterQuery/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../tax.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../tax.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../tax.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
www/apps/resources/references/tax/types/tax.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
---
displayed_sidebar: taxReference
---
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
www/apps/resources/references/types/DAL/interfaces/types.DAL.FindOptions/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ An object used to specify filters and options on a list of items.
## Properties
<TypeList types={[{"name":"where","type":"&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...)[(...)] extends (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) ? (...) \\| (...) : (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;T, any&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindOptions"/>
<TypeList types={[{"name":"where","type":"[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/vLine truncated
www/apps/resources/references/types/DAL/interfaces/types.DAL.OptionsQuery/page.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ The options to apply when retrieving an item.
## Type parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"P","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OptionsQuery"/>
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OptionsQuery"/>
## Properties
www/apps/resources/references/types/DAL/interfaces/types.DAL.RepositoryService/page.mdx
+14 -14
View File
@@ -64,21 +64,21 @@ ORM directly and allows to switch to another ORM without changing the business l
#### Parameters
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...)[(...)] extends (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) ? (...) \\| (...) : (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;T, any&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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 Line truncated
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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":"enableNestedTransactLine truncated
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="find"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="find"/>
### findAndCount
#### Parameters
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...)[(...)] extends (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) ? (...) \\| (...) : (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;T, any&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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 Line truncated
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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":"enableNestedTransactLine truncated
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[T[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","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="findAndCount"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","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="findAndCount"/>
### create
@@ -88,7 +88,7 @@ ORM directly and allows to switch to another ORM without changing the business l
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
### update
@@ -98,13 +98,13 @@ ORM directly and allows to switch to another ORM without changing the business l
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
### delete
#### Parameters
<TypeList types={[{"name":"idsOrPKs","type":"&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...)[(...)] extends (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) ? (...) \\| (...) : (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.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,"Line truncated
<TypeList types={[{"name":"idsOrPKs","type":"[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.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,"defaultValueLine truncated
#### Returns
@@ -116,21 +116,21 @@ Soft delete entities and cascade to related entities if configured.
#### Parameters
<TypeList types={[{"name":"idsOrFilter","type":"`string` \\| `string`[] \\| `object` \\| `object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="softDelete"/>
<TypeList types={[{"name":"idsOrFilter","type":"`string` \\| `string`[] \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62; \\| ([FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="softDelete"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[T[], Record&#60;string, unknown[]&#62;]&#62;","optional":false,"defaultValue":"","description":"[T[], Record&#60;string, string[]&#62;] the second value being the map of the entity names and ids that were soft deleted","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, 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="softDelete"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[], Record&#60;string, unknown[]&#62;]&#62;","optional":false,"defaultValue":"","description":"[T[], Record&#60;string, string[]&#62;] the second value being the map of the entity names and ids that were soft deleted","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, 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="softDelete"/>
### restore
#### Parameters
<TypeList types={[{"name":"idsOrFilter","type":"`string`[] \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="restore"/>
<TypeList types={[{"name":"idsOrFilter","type":"`string`[] \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="restore"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[T[], Record&#60;string, unknown[]&#62;]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, 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="restore"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[], Record&#60;string, unknown[]&#62;]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, 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="restore"/>
### upsert
@@ -140,14 +140,14 @@ Soft delete entities and cascade to related entities if configured.
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsert"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsert"/>
### upsertWithReplace
#### Parameters
<TypeList types={[{"name":"data","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[UpsertWithReplaceConfig](../types.DAL.UpsertWithReplaceConfig/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"relations","type":"keyof T[]","description":"The relationships that will be updated/created/deleted as part of the upsert","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="upsertWithReplace"/>
<TypeList types={[{"name":"data","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[UpsertWithReplaceConfig](../types.DAL.UpsertWithReplaceConfig/page.mdx)&#60;[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"relations","type":"keyof T[]","description":"The relationships that will be updated/created/deleted as part of the upsert","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="upsertWithReplace"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"entities","type":"T[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"performedActions","type":"[PerformedActions](../../types/types.DAL.PerformedActions/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"created","type":"`Record<[EntityClassName](../../../types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated","type":"`Record<[EntityClassName](../../../types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`Record<[EntityClassName](../../../types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertWithReplace"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"entities","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"performedActions","type":"[PerformedActions](../../types/types.DAL.PerformedActions/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"created","type":"`Record<[EntityClassName](../../../types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated","type":"`Record<[EntityClassName](../../../types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`Record<[EntityClassName](../../../types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertWithReplace"/>
www/apps/resources/references/types/DAL/interfaces/types.DAL.TreeRepositoryService/page.mdx
+5 -5
View File
@@ -64,21 +64,21 @@ ORM directly and allows to switch to another ORM without changing the business l
#### Parameters
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...)[(...)] extends (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) ? (...) \\| (...) : (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;T, any&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"transformOptions","type":"[RepositoryTransformOptions](../../../CommonTypes/interfaces/types.CommonTypes.RepositoryTransformOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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":Line truncated
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"transformOptions","type":"[RepositoryTransformOptions](../../../CommonTypes/interfaces/types.CommonTypes.RepositoryTransformOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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 indiLine truncated
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="find"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="find"/>
### findAndCount
#### Parameters
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...)[(...)] extends (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) \\| (...) ? (...) \\| (...) : (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;&#123; [Key in string \\| number \\| symbol]?: T[Key] extends string \\| number \\| bigint \\| boolean \\| symbol \\| Date ? any[any] \\| OperatorMap&#60;any[any]&#62; : T[Key] extends U ? U extends Object ? V extends object ? &#123; [Key in string \\| number \\| symbol]?: (...) extends (...) ? (...) : (...) &#125; : never : never : never &#125;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;T, any&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"transformOptions","type":"[RepositoryTransformOptions](../../../CommonTypes/interfaces/types.CommonTypes.RepositoryTransformOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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":Line truncated
<TypeList types={[{"name":"options","type":"[FindOptions](../types.DAL.FindOptions/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"where","type":"[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62; & [BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62; extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, 3&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;, 3&#62;&#62;","description":"The filters to apply on the items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[OptionsQuery](../types.DAL.OptionsQuery/page.mdx)&#60;[InferEntityType](../../../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)&#60;T&#62;&#62;","description":"The options to apply when retrieving the items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"populate","type":"`string`[]","description":"Relations to populate in the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"orderBy","type":"[Order](../../../types/types.Order/page.mdx)&#60;T&#62; \\| [Order](../../../types/types.Order/page.mdx)&#60;T&#62;[]","description":"Fields to sort-order items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items retrieved in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before the retrieved items in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"The fields to include in each of the items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groupBy","type":"`string` \\| `string`[]","description":"Group results by a field or set of fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`boolean` \\| `string`[] \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#60;boolean \\| [Dictionary](../../../types/types.Dictionary/page.mdx)&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`string` & `object` \\| `\"select-in\"` \\| `\"joined\"`","description":"Load strategy (e.g for mikro orm it accept select-in or joined)","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"transformOptions","type":"[RepositoryTransformOptions](../../../CommonTypes/interfaces/types.CommonTypes.RepositoryTransformOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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 indiLine truncated
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[T[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","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="findAndCount"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","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="findAndCount"/>
### create
@@ -88,7 +88,7 @@ ORM directly and allows to switch to another ORM without changing the business l
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType&#60;T&#62;[]","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferRepositoryReturnType","type":"[InferRepositoryReturnType](../../types/types.DAL.InferRepositoryReturnType/page.mdx)&#60;T&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
### delete
www/apps/resources/references/types/DAL/types/types.DAL.FilterQuery/page.mdx
+1 -1
View File
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
# FilterQuery
**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../../../ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
## Type Parameters
www/apps/resources/references/types/DAL/types/types.DAL.InferRepositoryReturnType/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# InferRepositoryReturnType
**InferRepositoryReturnType**: T extends [IDmlEntity](../../../DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;any, any&#62; ? [InferTypeOf](../../../DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx)&#60;T&#62; : EntityClass&#60;T&#62;[`"prototype"`]
Either infer the properties from a DML object or from a Mikro orm class prototype.
## Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InferRepositoryReturnType"/>
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx
+1 -1
View File
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
# InferForeignKeys
**InferForeignKeys**: &#123; [K in keyof Schema as Schema[K] extends Object ? Type extends RelationshipTypes ? \`$&#123;K & string&#125;\_id\` : never : never]: Schema[K] extends Object ? Type extends RelationshipTypes ? string : never : never &#125;
**InferForeignKeys**: &#123; [K in keyof Schema as Schema[K] extends Object ? \`$&#123;K & string&#125;\_id\` : never]: Schema[K] extends Object ? null extends Schema[K]["$dataType"] ? string \| null : string : never &#125;
From a IDmlEntity, infer the foreign keys name and type for
"belongsTo" relation meaning "hasOne" and "ManyToOne"
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx
+1 -1
View File
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
# InferSchemaFields
**InferSchemaFields**: [Prettify](../../../CommonTypes/types/types.CommonTypes.Prettify/page.mdx)&#60;&#123; [K in keyof Schema]: Schema[K] extends RelationshipType&#60;any&#62; ? Schema[K]["type"] extends "belongsTo" ? InferBelongsToFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasOne" ? InferHasOneFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasMany" ? InferHasManyFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "manyToMany" ? InferManyToManyFields&#60;Schema[K]["$dataType"]&#62; : never : Schema[K]["$dataType"] &#125;&#62;
**InferSchemaFields**: [Prettify](../../../CommonTypes/types/types.CommonTypes.Prettify/page.mdx)&#60;&#123; [K in keyof Schema]: Schema[K] extends RelationshipType&#60;any&#62; ? Schema[K]["type"] extends "belongsTo" ? InferBelongsToFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasOne" ? InferHasOneFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasMany" ? InferHasManyFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "manyToMany" ? InferManyToManyFields&#60;(...)[(...)]["$dataType"]&#62; : never : Schema[K]["$dataType"] &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;Schema&#62;&#62;
Inferring the types of the schema fields from the DML
entity
www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# IsNullableRelation
**IsNullableRelation**: T extends () => [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;any, any&#62; \| `null` ? `true` : `false`
Return true if the relationship is nullable
## Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IsNullableRelation"/>
www/apps/resources/references/types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.IMedusaInternalService/page.mdx
+7 -7
View File
@@ -44,7 +44,7 @@ ___
#### Parameters
<TypeList types={[{"name":"filters","type":"`object` \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;object&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)&#60;any&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../CommonTypes/types/types.CommonTypes.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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":"Line truncated
<TypeList types={[{"name":"filters","type":"[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62; \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)&#60;any&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../CommonTypes/types/types.CommonTypes.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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 `transactiLine truncated
#### Returns
@@ -54,7 +54,7 @@ ___
#### Parameters
<TypeList types={[{"name":"filters","type":"`object` \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;object&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)&#60;any&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../CommonTypes/types/types.CommonTypes.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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":"Line truncated
<TypeList types={[{"name":"filters","type":"[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62; \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)&#60;any&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../CommonTypes/types/types.CommonTypes.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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 `transactiLine truncated
#### Returns
@@ -108,7 +108,7 @@ ___
#### Parameters
<TypeList types={[{"name":"selectorAndData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"`object` \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="update"/>
<TypeList types={[{"name":"selectorAndData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62; \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="update"/>
#### Returns
@@ -118,7 +118,7 @@ ___
#### Parameters
<TypeList types={[{"name":"selectorAndData","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"`object` \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="update"/>
<TypeList types={[{"name":"selectorAndData","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62; \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="update"/>
#### Returns
@@ -170,7 +170,7 @@ ___
#### Parameters
<TypeList types={[{"name":"idOrSelector","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"`object` \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="delete"/>
<TypeList types={[{"name":"idOrSelector","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62; \\| [BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="delete"/>
#### Returns
@@ -180,7 +180,7 @@ ___
#### Parameters
<TypeList types={[{"name":"idsOrFilter","type":"`string` \\| `string`[] \\| `object` \\| `object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="softDelete"/>
<TypeList types={[{"name":"idsOrFilter","type":"`string` \\| `string`[] \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62; \\| ([FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="softDelete"/>
#### Returns
@@ -190,7 +190,7 @@ ___
#### Parameters
<TypeList types={[{"name":"idsOrFilter","type":"`string`[] \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="restore"/>
<TypeList types={[{"name":"idsOrFilter","type":"`string`[] \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;unknown, 3&#62; \\| [FilterQueryProperties](../../../types/types.FilterQueryProperties/page.mdx)&#60;any, 3&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"","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/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent 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="restore"/>
#### Returns
www/apps/resources/references/types/interfaces/types.BaseRepositoryService/page.mdx
-4
View File
@@ -6,10 +6,6 @@ Data access layer (DAL) interface to implements for any repository service.
This layer helps to separate the business logic (service layer) from accessing the
ORM directly and allows to switch to another ORM without changing the business logic.
## Type parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="BaseRepositoryService"/>
## Methods
### transaction
www/apps/resources/references/types/types.DAL/page.mdx
+1
View File
@@ -16,6 +16,7 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [FilterQuery](../DAL/types/types.DAL.FilterQuery/page.mdx)
- [InferRepositoryReturnType](../DAL/types/types.DAL.InferRepositoryReturnType/page.mdx)
- [ModelDateColumns](../DAL/types/types.DAL.ModelDateColumns/page.mdx)
- [OperatorMap](../DAL/types/types.DAL.OperatorMap/page.mdx)
- [PerformedActions](../DAL/types/types.DAL.PerformedActions/page.mdx)
www/apps/resources/references/types/types.DmlTypes/page.mdx
+1
View File
@@ -25,6 +25,7 @@ import { TypeList } from "docs-ui"
- [InferManyToManyFields](../DmlTypes/types/types.DmlTypes.InferManyToManyFields/page.mdx)
- [InferSchemaFields](../DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx)
- [InferTypeOf](../DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx)
- [IsNullableRelation](../DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx)
- [KnownDataTypes](../DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx)
- [NeQueryValue](../DmlTypes/types/types.DmlTypes.NeQueryValue/page.mdx)
- [PropertyMetadata](../DmlTypes/types/types.DmlTypes.PropertyMetadata/page.mdx)
www/apps/resources/references/types/types/types.FilterQueryProperties/page.mdx
+9
View File
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# FilterQueryProperties
**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
## Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"Prev","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FilterQueryProperties"/>
www/apps/resources/sidebar.mjs
+1 -1
View File
@@ -1062,7 +1062,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
type: "category",
title: "Data Models",
hasTitleStyling: true,
autogenerate_path: "/references/product_models/classes",
autogenerate_path: "/references/product_models/variables",
},
],
},