chore(docs): Generated References (automated) (#12267)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and 
GitHub committed
1 parent
3a9c19d3c2
commit
acff7887a2
149 files changed
+125236
-122430
No files matched your search
@@ -271,11 +271,11 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Fulfillment/core_flows.Fulfillment.Workflows_Fulfillment/page.mdx": "2024-12-23T12:30:23.905Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createCompleteReturnStep/page.mdx": "2025-04-11T09:04:37.117Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderChangeStep/page.mdx": "2025-04-11T09:04:36.949Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx": "2025-04-11T09:04:36.868Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx": "2025-04-23T07:49:39.383Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangesStep/page.mdx": "2025-04-11T09:04:37.029Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createReturnsStep/page.mdx": "2025-04-11T09:04:37.146Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.previewOrderChangeStep/page.mdx": "2025-04-11T09:04:37.071Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx": "2025-04-11T09:04:37.214Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx": "2025-04-23T07:49:39.782Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderWorkflow/page.mdx": "2025-04-11T09:04:37.380Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginExchangeOrderWorkflow/page.mdx": "2025-04-11T09:04:38.234Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditOrderWorkflow/page.mdx": "2025-04-11T09:04:38.775Z",
|
||||
@@ -365,7 +365,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeAddItemWorkflow/page.mdx": "2025-04-11T09:04:38.611Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodValidationStep/page.mdx": "2025-04-11T09:04:38.619Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodWorkflow/page.mdx": "2025-04-11T09:04:38.653Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx": "2025-04-11T09:04:40.162Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx": "2025-04-23T07:49:42.843Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemValidationStep/page.mdx": "2025-04-11T09:04:39.176Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemWorkflow/page.mdx": "2025-04-11T09:04:39.208Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditItemQuantityValidationStep/page.mdx": "2025-04-11T09:04:39.223Z",
|
||||
@@ -425,8 +425,8 @@ export const generatedEditDates = {
|
||||
"references/helper_steps/functions/helper_steps.updateRemoteLinksStep/page.mdx": "2025-01-17T16:43:22.238Z",
|
||||
"references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput/page.mdx": "2024-08-28T00:11:31.042Z",
|
||||
"references/medusa_config/interfaces/medusa_config.AdminOptions/page.mdx": "2025-02-24T10:48:34.425Z",
|
||||
"references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx": "2025-04-17T08:50:17.065Z",
|
||||
"references/medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx": "2025-02-11T11:36:46.417Z",
|
||||
"references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx": "2025-04-23T07:49:46.363Z",
|
||||
"references/medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx": "2025-04-23T07:49:46.337Z",
|
||||
"references/modules/auth/page.mdx": "2024-11-25T17:49:28.795Z",
|
||||
"references/modules/modules_sdk/page.mdx": "2025-02-24T10:48:34.485Z",
|
||||
"references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx": "2025-02-24T10:48:34.556Z",
|
||||
@@ -476,9 +476,9 @@ export const generatedEditDates = {
|
||||
"references/stock_location_next/interfaces/stock_location_next.ShippingOptionRuleDTO/page.mdx": "2024-12-23T13:57:07.694Z",
|
||||
"references/stock_location_next/interfaces/stock_location_next.ShippingOptionTypeDTO/page.mdx": "2024-12-23T13:57:07.696Z",
|
||||
"references/stock_location_next/interfaces/stock_location_next.ShippingProfileDTO/page.mdx": "2024-12-23T13:57:07.704Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.AdminOptions/page.mdx": "2025-02-24T10:48:36.584Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ConfigModule/page.mdx": "2025-04-17T08:50:17.064Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ProjectConfigOptions/page.mdx": "2025-02-11T11:36:48.560Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.AdminOptions/page.mdx": "2025-04-23T07:49:48.882Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ConfigModule/page.mdx": "2025-04-23T07:49:48.894Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.ProjectConfigOptions/page.mdx": "2025-04-23T07:49:48.887Z",
|
||||
"references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx": "2025-01-13T18:05:54.049Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx": "2024-12-09T13:21:33.021Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimRequestResponse/page.mdx": "2025-04-11T09:04:46.482Z",
|
||||
@@ -588,13 +588,13 @@ export const generatedEditDates = {
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReservationParams/page.mdx": "2024-12-09T13:21:34.509Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCustomerGroup/page.mdx": "2024-12-09T13:21:33.573Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReservation/page.mdx": "2025-04-11T09:04:47.500Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminWorkflowExecutionStep/page.mdx": "2025-04-11T09:04:47.746Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminWorkflowExecutionStep/page.mdx": "2025-04-23T07:49:50.845Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.WorkflowExecutionContext/page.mdx": "2025-04-11T09:04:47.742Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.WorkflowExecutionDefinition/page.mdx": "2025-04-11T09:04:47.743Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.WorkflowExecutionDefinition/page.mdx": "2025-04-23T07:49:50.843Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.WorkflowExecutionFn/page.mdx": "2025-04-11T09:04:47.744Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.AdminCustomerGroupListResponse/page.mdx": "2024-08-30T00:11:02.090Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.StepError/page.mdx": "2025-04-11T09:04:47.740Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.StepInvokeResult/page.mdx": "2025-04-11T09:04:47.738Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.StepInvokeResult/page.mdx": "2025-04-23T07:49:50.838Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.TransactionState/page.mdx": "2024-08-30T00:11:02.502Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.TransactionStepState/page.mdx": "2024-08-30T00:11:02.502Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.TransactionStepStatus/page.mdx": "2024-08-30T00:11:02.498Z",
|
||||
@@ -642,8 +642,8 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx": "2025-04-11T09:04:35.920Z",
|
||||
"references/core_flows/Cart/core_flows.Cart.Steps_Cart/page.mdx": "2025-02-11T11:36:38.987Z",
|
||||
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx": "2025-01-13T17:30:23.158Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx": "2025-04-11T09:04:36.264Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx": "2025-04-11T09:04:36.280Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx": "2025-04-23T07:49:38.780Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx": "2025-04-23T07:49:38.796Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderClaimStep/page.mdx": "2025-01-17T16:43:22.988Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderExchangeStep/page.mdx": "2025-01-17T16:43:23.041Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderReturnStep/page.mdx": "2025-01-17T16:43:23.074Z",
|
||||
@@ -685,7 +685,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/types/core_flows.UpdateOrderTaxLinesWorkflowInput/page.mdx": "2024-12-09T13:21:54.280Z",
|
||||
"references/core_flows/types/core_flows.UpdateTaxLinesWorkflowInput/page.mdx": "2025-04-11T09:04:41.814Z",
|
||||
"references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx": "2025-01-17T16:43:22.250Z",
|
||||
"references/modules/types/page.mdx": "2025-04-11T09:04:45.765Z",
|
||||
"references/modules/types/page.mdx": "2025-04-23T07:49:48.757Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx": "2025-04-11T09:04:50.621Z",
|
||||
"references/order/interfaces/order.CancelOrderClaimDTO/page.mdx": "2025-01-17T16:43:29.277Z",
|
||||
"references/order/interfaces/order.CancelOrderExchangeDTO/page.mdx": "2025-01-17T16:43:29.280Z",
|
||||
@@ -719,10 +719,10 @@ export const generatedEditDates = {
|
||||
"references/cart/interfaces/cart.LineItemAdjustmentDTO/page.mdx": "2025-04-11T09:04:43.840Z",
|
||||
"references/cart/interfaces/cart.LineItemTaxLineDTO/page.mdx": "2025-04-11T09:04:43.862Z",
|
||||
"references/cart/interfaces/cart.UpdateLineItemWithSelectorDTO/page.mdx": "2025-04-11T09:04:43.987Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx": "2025-04-11T09:04:35.451Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx": "2025-04-23T07:49:37.916Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx": "2025-04-11T09:04:35.478Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx": "2025-04-11T09:04:35.520Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx": "2025-04-11T09:04:35.594Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx": "2025-04-23T07:49:38.064Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx": "2025-04-11T09:04:35.657Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartShippingOptionsStep/page.mdx": "2025-04-11T09:04:35.692Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.validateExistingPaymentCollectionStep/page.mdx": "2025-04-11T09:04:35.832Z",
|
||||
@@ -790,7 +790,7 @@ export const generatedEditDates = {
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionDeleteResponse/page.mdx": "2024-12-09T13:21:34.725Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.DeleteResponse/page.mdx": "2024-12-09T13:21:33.545Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundStep/page.mdx": "2025-04-11T09:04:40.478Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx": "2025-04-11T09:04:36.729Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx": "2025-04-23T07:49:39.262Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.archiveOrdersStep/page.mdx": "2025-04-11T09:04:36.761Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.completeOrdersStep/page.mdx": "2025-04-11T09:04:36.903Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrdersStep/page.mdx": "2025-04-11T09:04:36.982Z",
|
||||
@@ -930,9 +930,9 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Auth/core_flows.Auth.Steps_Auth/page.mdx": "2024-12-23T12:30:23.503Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimItemsFromActionsStep/page.mdx": "2025-04-11T09:04:36.809Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangeItemsFromActionsStep/page.mdx": "2025-04-11T09:04:37.037Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2025-04-11T09:04:37.186Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2025-04-11T09:04:38.076Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2025-04-11T09:04:40.132Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2025-04-23T07:49:39.710Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2025-04-23T07:49:40.671Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2025-04-23T07:49:42.813Z",
|
||||
"references/core_flows/core_flows.Auth/page.mdx": "2024-12-23T12:30:23.503Z",
|
||||
"references/core_flows/core_flows.Steps_Auth/page.mdx": "2024-12-09T13:21:37.257Z",
|
||||
"references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx": "2025-04-11T09:04:41.976Z",
|
||||
@@ -942,7 +942,7 @@ export const generatedEditDates = {
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.retrieveOrderChangeAction/page.mdx": "2025-04-11T09:04:50.253Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChangeActions/page.mdx": "2025-04-11T09:04:50.261Z",
|
||||
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx": "2025-02-24T10:48:38.938Z",
|
||||
"references/types/types.CommonTypes/page.mdx": "2025-01-13T17:30:27.580Z",
|
||||
"references/types/types.CommonTypes/page.mdx": "2025-04-23T07:49:48.845Z",
|
||||
"app/storefront-development/publishable-api-keys/page.mdx": "2025-03-26T10:31:43.815Z",
|
||||
"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-11-27T16:33:40.706Z",
|
||||
@@ -1070,7 +1070,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Inventory/core_flows.Inventory.Steps_Inventory/page.mdx": "2024-12-23T12:30:23.988Z",
|
||||
"references/core_flows/Inventory/core_flows.Inventory.Workflows_Inventory/page.mdx": "2025-01-13T17:30:23.526Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderLineItemsStep/page.mdx": "2025-04-11T09:04:36.918Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2025-04-11T09:04:37.155Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2025-04-23T07:49:39.680Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx": "2025-04-11T09:04:37.273Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx": "2025-04-11T09:04:37.341Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx": "2025-04-11T09:04:40.895Z",
|
||||
@@ -1159,7 +1159,7 @@ export const generatedEditDates = {
|
||||
"references/dml/entity/classes/dml.entity.DmlEntity/page.mdx": "2025-01-13T18:05:57.749Z",
|
||||
"references/dml/entity_builder/EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx": "2025-01-13T18:05:57.746Z",
|
||||
"references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx": "2025-01-13T18:05:57.744Z",
|
||||
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2025-03-12T12:28:32.076Z",
|
||||
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2025-04-23T07:49:56.259Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillmentSets/page.mdx": "2025-04-11T09:04:45.164Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createGeoZones/page.mdx": "2025-04-11T09:04:45.244Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createServiceZones/page.mdx": "2025-04-11T09:04:45.199Z",
|
||||
@@ -1482,7 +1482,7 @@ export const generatedEditDates = {
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionTargetRules/page.mdx": "2025-04-11T09:04:51.974Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionsToCampaign/page.mdx": "2025-04-11T09:04:52.016Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.createCampaigns/page.mdx": "2025-04-11T09:04:51.988Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.createPromotions/page.mdx": "2025-04-11T09:04:51.947Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.createPromotions/page.mdx": "2025-04-23T07:49:55.252Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.deleteCampaigns/page.mdx": "2025-04-11T09:04:52.010Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.deletePromotions/page.mdx": "2025-04-11T09:04:51.965Z",
|
||||
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.listAndCountCampaigns/page.mdx": "2025-04-11T09:04:52.004Z",
|
||||
@@ -1593,7 +1593,7 @@ export const generatedEditDates = {
|
||||
"references/tax_provider/types/tax_provider.ShippingTaxCalculationLine/page.mdx": "2024-12-09T13:22:04.460Z",
|
||||
"references/types/DAL/interfaces/types.DAL.RepositoryService/page.mdx": "2025-04-11T09:04:45.938Z",
|
||||
"references/types/DAL/interfaces/types.DAL.TreeRepositoryService/page.mdx": "2025-04-11T09:04:45.950Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx": "2025-04-11T09:04:46.106Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx": "2025-04-23T07:49:49.128Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx": "2025-04-11T09:04:46.440Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx": "2025-04-11T09:04:46.436Z",
|
||||
"references/types/InventoryTypes/interfaces/types.InventoryTypes.FilterableInventoryLevelProps/page.mdx": "2025-01-13T18:05:55.187Z",
|
||||
@@ -1608,7 +1608,7 @@ export const generatedEditDates = {
|
||||
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution/page.mdx": "2025-01-13T18:05:55.289Z",
|
||||
"references/types/StockLocationTypes/interfaces/types.StockLocationTypes.IStockLocationService/page.mdx": "2025-04-11T09:04:48.616Z",
|
||||
"references/types/interfaces/types.Context/page.mdx": "2025-04-11T09:04:48.555Z",
|
||||
"references/types/interfaces/types.ILinkModule/page.mdx": "2025-04-11T09:04:48.158Z",
|
||||
"references/types/interfaces/types.ILinkModule/page.mdx": "2025-04-23T07:49:51.308Z",
|
||||
"references/types/interfaces/types.JoinerServiceConfig/page.mdx": "2025-01-13T18:05:55.235Z",
|
||||
"references/types/interfaces/types.JoinerServiceConfigAlias/page.mdx": "2024-12-09T13:21:35.189Z",
|
||||
"references/types/interfaces/types.RemoteExpandProperty/page.mdx": "2025-01-13T18:05:55.240Z",
|
||||
@@ -1639,10 +1639,10 @@ export const generatedEditDates = {
|
||||
"references/utils/utils.FulfillmentUtils/page.mdx": "2024-12-09T13:21:35.933Z",
|
||||
"references/utils/utils.LinkUtils/page.mdx": "2025-02-11T11:36:54.886Z",
|
||||
"references/utils/utils.OrderUtils/page.mdx": "2024-11-25T17:49:28.559Z",
|
||||
"references/workflows/interfaces/workflows.StepExecutionContext/page.mdx": "2025-04-11T09:04:53.158Z",
|
||||
"references/workflows/types/workflows.CompensateFn/page.mdx": "2025-01-13T17:30:31.418Z",
|
||||
"references/workflows/interfaces/workflows.StepExecutionContext/page.mdx": "2025-04-23T07:49:56.562Z",
|
||||
"references/workflows/types/workflows.CompensateFn/page.mdx": "2025-04-23T07:49:56.524Z",
|
||||
"references/workflows/types/workflows.CreateWorkflowComposerContext/page.mdx": "2024-12-23T13:57:08.060Z",
|
||||
"references/workflows/types/workflows.InvokeFn/page.mdx": "2025-01-13T17:30:31.417Z",
|
||||
"references/workflows/types/workflows.InvokeFn/page.mdx": "2025-04-23T07:49:56.522Z",
|
||||
"references/workflows/types/workflows.StepFunctionResult/page.mdx": "2024-12-23T13:57:08.055Z",
|
||||
"references/types/IndexTypes/interfaces/types.IndexTypes.IIndexService/page.mdx": "2024-12-09T13:21:35.053Z",
|
||||
"references/types/types.IndexTypes/page.mdx": "2024-11-25T17:49:27.627Z",
|
||||
@@ -1720,7 +1720,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodAdjustmentsStep/page.mdx": "2025-01-13T17:30:23.012Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodFromCartStep/page.mdx": "2025-01-13T17:30:23.013Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.reserveInventoryStep/page.mdx": "2025-04-11T09:04:35.568Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx": "2025-04-11T09:04:35.602Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx": "2025-04-23T07:49:38.071Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx": "2025-01-13T18:05:49.333Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx": "2025-04-11T09:04:35.874Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx": "2025-04-11T09:04:35.898Z",
|
||||
@@ -1731,7 +1731,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStep/page.mdx": "2025-01-13T17:30:23.186Z",
|
||||
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomerAddressesStep/page.mdx": "2025-04-11T09:04:36.011Z",
|
||||
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomersStep/page.mdx": "2025-04-11T09:04:36.018Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx": "2025-04-11T09:04:36.103Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx": "2025-04-23T07:49:38.591Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStep/page.mdx": "2025-01-13T17:30:23.255Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStep/page.mdx": "2025-01-13T18:05:49.505Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupsStep/page.mdx": "2025-04-11T09:04:36.117Z",
|
||||
@@ -1741,15 +1741,15 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx": "2025-03-04T13:33:40.865Z",
|
||||
"references/core_flows/Defaults/Steps_Defaults/functions/core_flows.Defaults.Steps_Defaults.createDefaultStoreStep/page.mdx": "2025-01-13T17:30:23.305Z",
|
||||
"references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx": "2025-03-04T13:33:40.896Z",
|
||||
"references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx": "2025-04-17T08:42:13.668Z",
|
||||
"references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx": "2025-04-17T08:42:17.200Z",
|
||||
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx": "2025-04-17T08:42:22.928Z",
|
||||
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx": "2025-04-17T08:42:27.243Z",
|
||||
"references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx": "2025-04-23T07:49:38.659Z",
|
||||
"references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx": "2025-04-23T07:49:38.662Z",
|
||||
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx": "2025-04-23T07:49:38.671Z",
|
||||
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx": "2025-04-23T07:49:38.667Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStep/page.mdx": "2025-01-13T17:30:23.344Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx": "2025-04-11T09:04:36.199Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx": "2025-04-11T09:04:36.257Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx": "2025-04-11T09:04:36.185Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx": "2025-04-11T09:04:36.271Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx": "2025-04-23T07:49:38.699Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx": "2025-04-23T07:49:38.773Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx": "2025-04-23T07:49:38.681Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx": "2025-04-23T07:49:38.787Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteFulfillmentSetsStep/page.mdx": "2025-01-13T17:30:23.386Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteServiceZonesStep/page.mdx": "2025-01-13T17:30:23.387Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionsStep/page.mdx": "2025-01-13T17:30:23.392Z",
|
||||
@@ -1773,7 +1773,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.createInventoryLevelsStep/page.mdx": "2025-04-11T09:04:36.537Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.deleteInventoryItemStep/page.mdx": "2025-01-13T17:30:23.517Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.deleteInventoryLevelsStep/page.mdx": "2025-01-13T17:30:23.519Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx": "2025-04-11T09:04:36.554Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx": "2025-04-23T07:49:39.076Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep/page.mdx": "2025-04-11T09:04:36.558Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate/page.mdx": "2025-01-13T17:30:23.525Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStep/page.mdx": "2025-01-13T17:30:23.524Z",
|
||||
@@ -1788,24 +1788,24 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Invite/Steps_Invite/functions/core_flows.Invite.Steps_Invite.validateTokenStep/page.mdx": "2025-01-13T17:30:23.565Z",
|
||||
"references/core_flows/Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.deleteLineItemsStep/page.mdx": "2025-01-13T17:30:23.577Z",
|
||||
"references/core_flows/Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx": "2025-03-04T13:33:41.412Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx": "2025-04-11T09:04:36.767Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx": "2025-04-23T07:49:39.307Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderFulfillmentStep/page.mdx": "2025-01-13T18:05:49.821Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx": "2025-04-11T09:04:36.986Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx": "2025-04-11T09:04:36.872Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx": "2025-04-11T09:04:37.041Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx": "2025-04-11T09:04:36.991Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx": "2025-04-11T09:04:36.994Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx": "2025-04-11T09:04:36.988Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx": "2025-04-11T09:04:36.995Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx": "2025-04-11T09:04:37.149Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx": "2025-04-23T07:49:39.503Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx": "2025-04-23T07:49:39.387Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx": "2025-04-23T07:49:39.565Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx": "2025-04-23T07:49:39.508Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx": "2025-04-23T07:49:39.511Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx": "2025-04-23T07:49:39.505Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx": "2025-04-23T07:49:39.513Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx": "2025-04-23T07:49:39.671Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderFulfillmentStep/page.mdx": "2025-01-13T18:05:49.913Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderShipmentStep/page.mdx": "2025-01-13T17:30:23.699Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx": "2025-04-11T09:04:37.255Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx": "2025-04-23T07:49:39.831Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnItemsStep/page.mdx": "2025-01-13T18:05:49.942Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderClaimWorkflow/page.mdx": "2025-03-04T13:33:41.888Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx": "2025-03-04T13:33:43.258Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderExchangeWorkflow/page.mdx": "2025-03-04T13:33:42.706Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx": "2025-04-11T09:04:37.308Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx": "2025-04-23T07:49:39.888Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderClaimWorkflow/page.mdx": "2025-03-04T13:33:41.897Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderExchangeWorkflow/page.mdx": "2025-03-04T13:33:42.715Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnReceiveWorkflow/page.mdx": "2025-03-04T13:33:43.856Z",
|
||||
@@ -1814,27 +1814,27 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx": "2025-04-11T09:04:39.566Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createCompleteReturnValidationStep/page.mdx": "2025-02-11T11:36:42.766Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderPaymentCollectionWorkflow/page.mdx": "2025-04-11T09:04:38.088Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx": "2025-04-11T09:04:38.177Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx": "2025-04-11T09:04:38.185Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx": "2025-04-11T09:04:38.181Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx": "2025-04-23T07:49:40.782Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx": "2025-04-23T07:49:40.791Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx": "2025-04-23T07:49:40.787Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderPaymentCollections/page.mdx": "2025-03-04T13:33:42.643Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrderDetailWorkflow/page.mdx": "2025-03-04T13:33:43.119Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markPaymentCollectionAsPaid/page.mdx": "2025-03-04T13:33:43.198Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveAndCompleteReturnOrderWorkflow/page.mdx": "2025-03-04T13:33:44.144Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveCompleteReturnValidationStep/page.mdx": "2025-04-11T09:04:39.668Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessPaymentCollectionNotPaid/page.mdx": "2025-01-20T08:25:21.432Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx": "2025-04-11T09:04:38.189Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx": "2025-04-23T07:49:40.796Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.authorizePaymentSessionStep/page.mdx": "2025-02-11T11:36:43.569Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.cancelPaymentStep/page.mdx": "2025-01-13T17:30:25.526Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.capturePaymentStep/page.mdx": "2025-01-17T16:43:24.790Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentStep/page.mdx": "2025-01-17T16:43:24.798Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.capturePaymentWorkflow/page.mdx": "2025-03-04T13:33:44.880Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx": "2025-04-11T09:04:40.522Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx": "2025-04-23T07:49:43.222Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createRefundReasonStep/page.mdx": "2025-04-11T09:04:40.525Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx": "2025-04-11T09:04:40.529Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx": "2025-04-23T07:49:43.232Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deleteRefundReasonsStep/page.mdx": "2025-01-13T17:30:25.585Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updatePaymentCollectionStep/page.mdx": "2025-04-11T09:04:40.543Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx": "2025-04-11T09:04:40.546Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx": "2025-04-23T07:49:43.250Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.validateDeletedPaymentSessionsStep/page.mdx": "2025-01-13T17:30:25.592Z",
|
||||
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createPaymentSessionsWorkflow/page.mdx": "2025-03-04T13:33:44.971Z",
|
||||
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createRefundReasonsWorkflow/page.mdx": "2025-04-11T09:04:40.568Z",
|
||||
@@ -1844,7 +1844,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStep/page.mdx": "2025-01-13T17:30:25.619Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.removePriceListPricesStep/page.mdx": "2025-01-13T17:30:25.620Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListsStep/page.mdx": "2025-04-11T09:04:40.617Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx": "2025-04-11T09:04:40.621Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx": "2025-04-23T07:49:43.332Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStep/page.mdx": "2025-01-13T17:30:25.630Z",
|
||||
"references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx": "2025-03-04T13:33:45.057Z",
|
||||
"references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx": "2025-03-04T13:33:45.061Z",
|
||||
@@ -1858,7 +1858,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx": "2025-03-04T13:33:45.109Z",
|
||||
"references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx": "2025-04-11T09:04:40.710Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.batchLinkProductsToCollectionStep/page.mdx": "2025-01-13T18:05:52.101Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx": "2025-04-11T09:04:40.731Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx": "2025-04-23T07:49:43.455Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx": "2025-04-11T09:04:40.737Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx": "2025-04-11T09:04:40.811Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTypesStep/page.mdx": "2025-04-11T09:04:40.815Z",
|
||||
@@ -1871,7 +1871,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteProductTypesStep/page.mdx": "2025-01-13T17:30:25.727Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteProductVariantsStep/page.mdx": "2025-01-13T17:30:25.696Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteProductsStep/page.mdx": "2025-01-13T17:30:25.698Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx": "2025-04-17T08:42:38.910Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx": "2025-04-23T07:49:43.561Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getAllProductsStep/page.mdx": "2025-02-11T11:36:43.882Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getProductsStep/page.mdx": "2025-04-11T09:04:40.771Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.groupProductsForBatchStep/page.mdx": "2025-02-24T10:48:31.999Z",
|
||||
@@ -1887,8 +1887,8 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCollectionWorkflow/page.mdx": "2025-03-04T13:33:45.249Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx": "2025-03-04T13:33:45.257Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx": "2025-04-11T09:04:40.887Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.exportProductsWorkflow/page.mdx": "2025-04-17T08:42:40.742Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.importProductsWorkflow/page.mdx": "2025-04-17T08:42:45.102Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.exportProductsWorkflow/page.mdx": "2025-04-23T07:49:43.763Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.importProductsWorkflow/page.mdx": "2025-04-23T07:49:43.768Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.upsertVariantPricesWorkflow/page.mdx": "2025-03-04T13:33:45.416Z",
|
||||
"references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.createProductCategoriesStep/page.mdx": "2025-04-11T09:04:41.068Z",
|
||||
"references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.deleteProductCategoriesStep/page.mdx": "2025-01-13T17:30:25.836Z",
|
||||
@@ -1933,7 +1933,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.linkProductsToSalesChannelWorkflow/page.mdx": "2025-03-04T13:33:45.722Z",
|
||||
"references/core_flows/Shipping_Profile/Steps_Shipping_Profile/functions/core_flows.Shipping_Profile.Steps_Shipping_Profile.deleteShippingProfilesStep/page.mdx": "2025-01-13T17:30:25.996Z",
|
||||
"references/core_flows/Shipping_Profile/Workflows_Shipping_Profile/functions/core_flows.Shipping_Profile.Workflows_Shipping_Profile.deleteShippingProfileWorkflow/page.mdx": "2025-03-04T13:33:45.757Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.createStockLocations/page.mdx": "2025-04-11T09:04:41.425Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.createStockLocations/page.mdx": "2025-04-23T07:49:44.178Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.deleteStockLocationsStep/page.mdx": "2025-01-13T17:30:26.004Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.updateStockLocationsStep/page.mdx": "2025-04-11T09:04:41.433Z",
|
||||
"references/core_flows/Stock_Location/Workflows_Stock_Location/functions/core_flows.Stock_Location.Workflows_Stock_Location.createLocationFulfillmentSetWorkflow/page.mdx": "2025-03-04T13:33:45.775Z",
|
||||
@@ -2161,7 +2161,7 @@ export const generatedEditDates = {
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx": "2025-02-11T11:36:48.538Z",
|
||||
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx": "2024-12-09T13:21:35.373Z",
|
||||
"references/user/interfaces/user.FindConfig/page.mdx": "2025-02-11T11:36:54.693Z",
|
||||
"references/workflows/types/workflows.StepFunction/page.mdx": "2024-12-09T13:22:04.832Z",
|
||||
"references/workflows/types/workflows.StepFunction/page.mdx": "2025-04-23T07:49:56.555Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx": "2025-04-11T09:04:35.737Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentData/page.mdx": "2025-01-17T16:43:27.199Z",
|
||||
"references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx": "2024-12-17T16:57:25.097Z",
|
||||
@@ -2199,7 +2199,7 @@ export const generatedEditDates = {
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productTag/page.mdx": "2025-01-13T18:05:58.392Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productType/page.mdx": "2025-01-13T18:05:58.209Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx": "2025-03-04T13:33:58.468Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx": "2025-04-11T09:04:55.068Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx": "2025-04-23T07:49:58.542Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx": "2025-04-11T09:04:54.990Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.region/page.mdx": "2025-04-11T09:04:54.541Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.reservation/page.mdx": "2025-04-11T09:04:55.033Z",
|
||||
@@ -2435,7 +2435,7 @@ export const generatedEditDates = {
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx": "2025-04-11T09:04:56.147Z",
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx": "2025-04-11T09:04:56.141Z",
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.delete/page.mdx": "2025-04-11T09:04:56.145Z",
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx": "2025-04-11T09:04:56.138Z",
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx": "2025-04-23T07:49:59.687Z",
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/page.mdx": "2025-04-11T09:04:56.156Z",
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx": "2025-04-11T09:04:56.159Z",
|
||||
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx": "2025-04-11T09:04:56.154Z",
|
||||
@@ -2624,7 +2624,7 @@ export const generatedEditDates = {
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx": "2025-01-13T18:05:59.452Z",
|
||||
"references/js_sdk/store/classes/js_sdk.store.Store/page.mdx": "2024-11-25T17:49:55.112Z",
|
||||
"references/modules/js_sdk/page.mdx": "2024-10-22T15:09:52.263Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx": "2025-04-11T09:04:36.541Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx": "2025-04-23T07:49:39.066Z",
|
||||
"references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflow/page.mdx": "2025-03-04T13:33:45.931Z",
|
||||
"references/core_flows/interfaces/core_flows.ValidateInventoryDeleteStepInput/page.mdx": "2024-12-09T13:21:50.648Z",
|
||||
"references/core_flows/types/core_flows.UseQueryGraphStepInput/page.mdx": "2024-12-09T13:21:50.232Z",
|
||||
@@ -2967,7 +2967,7 @@ export const generatedEditDates = {
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPaymentProvidersParams/page.mdx": "2025-01-13T18:05:54.624Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionParams/page.mdx": "2024-12-09T13:21:34.445Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionRuleTypeParams/page.mdx": "2024-12-09T13:21:34.449Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx": "2025-04-11T09:04:47.442Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx": "2025-04-23T07:49:50.524Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsRuleValueParams/page.mdx": "2025-04-11T09:04:47.448Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx": "2025-04-11T09:04:46.901Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx": "2025-04-11T09:04:46.917Z",
|
||||
@@ -3276,7 +3276,7 @@ export const generatedEditDates = {
|
||||
"references/types/interfaces/types.BaseProductType/page.mdx": "2024-12-09T13:21:34.941Z",
|
||||
"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.FileTypes/page.mdx": "2025-04-23T07:49:49.086Z",
|
||||
"references/types/types.InventoryTypes/page.mdx": "2025-01-13T17:30:28.839Z",
|
||||
"references/types/types.StockLocationTypes/page.mdx": "2025-01-07T12:54:23.041Z",
|
||||
"references/user/interfaces/user.IMessageAggregator/page.mdx": "2024-11-25T17:49:59.536Z",
|
||||
@@ -4748,8 +4748,8 @@ export const generatedEditDates = {
|
||||
"references/medusa/types/medusa.Event/page.mdx": "2025-04-11T09:04:53.206Z",
|
||||
"references/medusa/types/medusa.MedusaPricingContext/page.mdx": "2024-12-17T16:57:19.802Z",
|
||||
"references/medusa/types/medusa.MedusaResponse/page.mdx": "2024-12-09T13:21:32.697Z",
|
||||
"references/medusa/types/medusa.MiddlewareRoute/page.mdx": "2025-03-04T13:33:56.786Z",
|
||||
"references/medusa/types/medusa.MiddlewaresConfig/page.mdx": "2025-03-04T13:33:56.788Z",
|
||||
"references/medusa/types/medusa.MiddlewareRoute/page.mdx": "2025-04-23T07:49:56.590Z",
|
||||
"references/medusa/types/medusa.MiddlewaresConfig/page.mdx": "2025-04-23T07:49:56.592Z",
|
||||
"references/medusa/types/medusa.ParserConfigArgs/page.mdx": "2024-12-09T13:21:32.681Z",
|
||||
"references/medusa/types/medusa.SubscriberConfig/page.mdx": "2024-12-09T13:21:32.737Z",
|
||||
"references/medusa_config/interfaces/medusa_config.HttpCompressionOptions/page.mdx": "2024-12-09T13:22:00.276Z",
|
||||
@@ -5080,15 +5080,15 @@ export const generatedEditDates = {
|
||||
"references/types/EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor/page.mdx": "2024-12-09T13:21:33.041Z",
|
||||
"references/types/FeatureFlagTypes/interfaces/types.FeatureFlagTypes.IFlagRouter/page.mdx": "2024-12-09T13:21:33.073Z",
|
||||
"references/types/FeatureFlagTypes/types/types.FeatureFlagTypes.FlagSettings/page.mdx": "2024-12-09T13:21:33.077Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx": "2025-04-11T09:04:46.082Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx": "2025-04-23T07:49:49.093Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.FileDTO/page.mdx": "2025-04-11T09:04:46.079Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.FilterableFileProps/page.mdx": "2024-12-09T13:21:33.093Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx": "2025-02-24T10:48:36.787Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx": "2025-04-23T07:49:49.107Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.LocalFileServiceOptions/page.mdx": "2024-12-09T13:21:33.109Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderDeleteFileDTO/page.mdx": "2024-12-09T13:21:33.097Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderFileResultDTO/page.mdx": "2025-02-24T10:48:36.779Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderGetFileDTO/page.mdx": "2025-02-24T10:48:36.780Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx": "2024-12-09T13:21:33.101Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx": "2025-04-23T07:49:49.100Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.S3FileServiceOptions/page.mdx": "2024-12-17T16:57:19.969Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddReturnItem/page.mdx": "2025-04-11T09:04:47.536Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddReturnItems/page.mdx": "2025-04-11T09:04:47.538Z",
|
||||
@@ -5484,7 +5484,6 @@ export const generatedEditDates = {
|
||||
"references/types/interfaces/types.RefundReason/page.mdx": "2024-12-09T13:21:34.909Z",
|
||||
"references/types/interfaces/types.RemoteJoinerOptions/page.mdx": "2025-02-11T11:36:50.670Z",
|
||||
"references/types/interfaces/types.RemoteJoinerQuery/page.mdx": "2024-12-09T13:21:35.197Z",
|
||||
"references/types/interfaces/types.SessionOptions/page.mdx": "2024-12-09T13:21:32.841Z",
|
||||
"references/types/interfaces/types.StoreCreateReturnItem/page.mdx": "2024-12-09T13:21:35.009Z",
|
||||
"references/types/interfaces/types.StoreCreateReturnShipping/page.mdx": "2024-12-09T13:21:35.013Z",
|
||||
"references/types/interfaces/types.UpdatePricePreferences/page.mdx": "2024-12-09T13:21:35.857Z",
|
||||
@@ -5727,7 +5726,7 @@ export const generatedEditDates = {
|
||||
"app/commerce-modules/customer/links-to-other-modules/page.mdx": "2025-04-17T15:43:54.168Z",
|
||||
"app/commerce-modules/fulfillment/events/page.mdx": "2024-12-31T09:37:49.253Z",
|
||||
"app/commerce-modules/payment/events/page.mdx": "2024-12-31T09:41:56.582Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx": "2025-04-11T09:04:40.443Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx": "2025-04-23T07:49:43.141Z",
|
||||
"references/core_flows/Payment/Steps_Payment/variables/core_flows.Payment.Steps_Payment.refundPaymentsStepId/page.mdx": "2025-01-07T12:54:17.422Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx": "2025-04-11T09:04:40.504Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validatePaymentsRefundStep/page.mdx": "2025-01-20T08:25:22.137Z",
|
||||
@@ -5736,7 +5735,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Tax/Steps_Tax/variables/core_flows.Tax.Steps_Tax.updateTaxRegionsStepId/page.mdx": "2025-01-07T12:54:18.224Z",
|
||||
"references/fulfillment/types/fulfillment.CartPropsForFulfillment/page.mdx": "2025-01-17T16:43:26.931Z",
|
||||
"references/fulfillment/types/fulfillment.ValidateFulfillmentDataContext/page.mdx": "2025-01-17T16:43:27.045Z",
|
||||
"references/modules_sdk/classes/modules_sdk.Link/page.mdx": "2025-02-11T11:36:46.494Z",
|
||||
"references/modules_sdk/classes/modules_sdk.Link/page.mdx": "2025-04-23T07:49:46.430Z",
|
||||
"references/stock_location_next/IStockLocationService/methods/stock_location_next.IStockLocationService.deleteStockLocationAddresses/page.mdx": "2025-04-11T09:04:52.433Z",
|
||||
"references/stock_location_next/IStockLocationService/methods/stock_location_next.IStockLocationService.listStockLocationAddresses/page.mdx": "2025-04-11T09:04:52.427Z",
|
||||
"references/stock_location_next/IStockLocationService/methods/stock_location_next.IStockLocationService.upsertStockLocationAddresses/page.mdx": "2025-04-11T09:04:52.430Z",
|
||||
@@ -5846,7 +5845,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deleteRefundReasonsWorkflow/page.mdx": "2025-03-04T13:33:44.991Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getVariantAvailabilityStep/page.mdx": "2025-01-17T16:43:24.975Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsStatusWorkflow/page.mdx": "2025-04-11T09:04:41.225Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsValidationStep/page.mdx": "2025-04-11T09:04:41.219Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsValidationStep/page.mdx": "2025-04-23T07:49:43.969Z",
|
||||
"references/core_flows/interfaces/core_flows.ValidateCartStepInput/page.mdx": "2025-04-11T09:04:41.757Z",
|
||||
"references/core_flows/interfaces/core_flows.ValidateProductInputStepInput/page.mdx": "2025-02-24T10:48:34.257Z",
|
||||
"references/core_flows/types/core_flows.ThrowUnlessPaymentCollectionNotePaidInput/page.mdx": "2025-01-17T16:43:25.819Z",
|
||||
@@ -5926,7 +5925,7 @@ export const generatedEditDates = {
|
||||
"app/recipes/erp/page.mdx": "2025-02-25T11:11:02.259Z",
|
||||
"app/recipes/erp/odoo/page.mdx": "2025-02-25T11:10:05.938Z",
|
||||
"app/commerce-modules/product/selling-products/page.mdx": "2025-02-13T13:27:09.270Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx": "2025-04-11T13:17:47.049Z",
|
||||
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx": "2025-04-23T07:49:58.193Z",
|
||||
"references/js_sdk/admin/Client/methods/js_sdk.admin.Client.throwError_/page.mdx": "2025-02-24T10:48:47.018Z",
|
||||
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.getItem/page.mdx": "2025-02-24T10:48:47.069Z",
|
||||
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.removeItem/page.mdx": "2025-02-24T10:48:47.072Z",
|
||||
@@ -5936,7 +5935,7 @@ export const generatedEditDates = {
|
||||
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.retrieve/page.mdx": "2025-04-11T09:04:54.068Z",
|
||||
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.update/page.mdx": "2025-04-11T13:17:46.774Z",
|
||||
"references/js_sdk/admin/DraftOrder/properties/js_sdk.admin.DraftOrder.client/page.mdx": "2025-02-24T10:48:44.111Z",
|
||||
"references/js_sdk/admin/classes/js_sdk.admin.DraftOrder/page.mdx": "2025-04-11T09:04:54.020Z",
|
||||
"references/js_sdk/admin/classes/js_sdk.admin.DraftOrder/page.mdx": "2025-04-23T07:49:57.422Z",
|
||||
"references/js_sdk/admin/interfaces/js_sdk.admin.CustomStorage/page.mdx": "2025-02-24T10:48:47.068Z",
|
||||
"references/js_sdk/admin/types/js_sdk.admin.Awaitable/page.mdx": "2025-02-24T10:48:47.067Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.upsertOrderLineItemAdjustments/page.mdx": "2025-04-11T09:04:50.053Z",
|
||||
@@ -6024,7 +6023,7 @@ export const generatedEditDates = {
|
||||
"references/cart/interfaces/cart.UpdateLineItemWithoutSelectorDTO/page.mdx": "2025-03-04T13:33:48.254Z",
|
||||
"references/cart_models/variables/cart_models.CreditLine/page.mdx": "2025-04-11T09:04:53.262Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflow/page.mdx": "2025-04-11T09:04:35.771Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx": "2025-04-11T09:04:35.842Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx": "2025-04-23T07:49:38.310Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflowId/page.mdx": "2025-03-04T13:33:40.515Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflowId/page.mdx": "2025-03-04T13:33:40.574Z",
|
||||
"references/fulfillment/interfaces/fulfillment.CartCreditLineDTO/page.mdx": "2025-03-04T13:33:48.973Z",
|
||||
@@ -6049,7 +6048,7 @@ export const generatedEditDates = {
|
||||
"references/modules/locking/page.mdx": "2025-03-12T12:28:30.419Z",
|
||||
"references/cache/interfaces/cache.ICacheService/page.mdx": "2025-04-17T08:41:49.104Z",
|
||||
"references/event/interfaces/event.IEventBusModuleService/page.mdx": "2025-04-17T08:41:49.516Z",
|
||||
"references/file_service/interfaces/file_service.IFileModuleService/page.mdx": "2025-04-11T09:04:44.817Z",
|
||||
"references/file_service/interfaces/file_service.IFileModuleService/page.mdx": "2025-04-23T07:49:47.759Z",
|
||||
"references/modules/cache/page.mdx": "2025-03-17T15:24:02.572Z",
|
||||
"references/modules/event/page.mdx": "2025-03-17T15:24:03.021Z",
|
||||
"references/modules/file_service/page.mdx": "2025-03-17T15:24:03.025Z",
|
||||
@@ -6111,7 +6110,7 @@ export const generatedEditDates = {
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateDraftOrderActionShippingMethod/page.mdx": "2025-04-11T09:04:46.667Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateDraftOrderItem/page.mdx": "2025-04-11T09:04:46.659Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateDraftOrderShippingMethod/page.mdx": "2025-04-11T09:04:46.668Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminWorkflowExecutionExecution/page.mdx": "2025-04-11T09:04:47.737Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminWorkflowExecutionExecution/page.mdx": "2025-04-23T07:49:50.836Z",
|
||||
"references/types/WorkflowsSdkTypes/interfaces/types.WorkflowsSdkTypes.WorkflowOrchestratorCancelOptionsDTO/page.mdx": "2025-04-11T09:04:48.930Z",
|
||||
"references/types/types/types.PluginAdminDetails/page.mdx": "2025-04-11T09:04:45.847Z",
|
||||
"references/workflows/StepExecutionContext/methods/workflows.StepExecutionContext._getStepResult/page.mdx": "2025-04-11T09:04:53.160Z",
|
||||
@@ -6145,8 +6144,15 @@ export const generatedEditDates = {
|
||||
"references/types/interfaces/types.IFulfillmentProvider/page.mdx": "2025-04-11T09:04:46.137Z",
|
||||
"references/user/types/user.Message/page.mdx": "2025-04-11T09:04:52.767Z",
|
||||
"app/infrastructure-modules/workflow-engine/how-to-use/page.mdx": "2025-03-27T14:53:13.311Z",
|
||||
"references/core_flows/Notification/Steps_Notification/functions/core_flows.Notification.Steps_Notification.notifyOnFailureStep/page.mdx": "2025-04-17T08:42:33.837Z",
|
||||
"references/core_flows/Notification/Steps_Notification/functions/core_flows.Notification.Steps_Notification.notifyOnFailureStep/page.mdx": "2025-04-23T07:49:39.255Z",
|
||||
"app/troubleshooting/api-routes/additional-data-error/page.mdx": "2025-03-27T17:39:10.858Z",
|
||||
"app/troubleshooting/api-routes/middleware-registration/page.mdx": "2025-04-17T10:35:42.095Z",
|
||||
"app/troubleshooting/query/expression-type-error/page.mdx": "2025-04-17T10:30:39.317Z"
|
||||
"app/troubleshooting/query/expression-type-error/page.mdx": "2025-04-17T10:30:39.317Z",
|
||||
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeShippingMethod/page.mdx": "2025-04-23T07:49:57.517Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.SessionOptions/page.mdx": "2025-04-23T07:49:48.883Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.GetUploadFileUrlDTO/page.mdx": "2025-04-23T07:49:49.094Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderGetPresignedUploadUrlDTO/page.mdx": "2025-04-23T07:49:49.101Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx": "2025-04-23T07:49:49.091Z",
|
||||
"references/types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx": "2025-04-23T07:49:49.087Z",
|
||||
"references/workflows/types/workflows.Void/page.mdx": "2025-04-23T07:49:56.553Z"
|
||||
}
|
||||
@@ -11567,6 +11567,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removePromotions/page.mdx",
|
||||
"pathname": "/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removePromotions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeShippingMethod/page.mdx",
|
||||
"pathname": "/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeShippingMethod"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.requestEdit/page.mdx",
|
||||
"pathname": "/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.requestEdit"
|
||||
@@ -18219,6 +18223,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/CommonTypes/interfaces/types.CommonTypes.RequestQueryFields/page.mdx",
|
||||
"pathname": "/references/types/CommonTypes/interfaces/types.CommonTypes.RequestQueryFields"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/CommonTypes/interfaces/types.CommonTypes.SessionOptions/page.mdx",
|
||||
"pathname": "/references/types/CommonTypes/interfaces/types.CommonTypes.SessionOptions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity/page.mdx",
|
||||
"pathname": "/references/types/CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity"
|
||||
@@ -18575,6 +18583,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.FilterableFileProps/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.FilterableFileProps"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.GetUploadFileUrlDTO/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.GetUploadFileUrlDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService"
|
||||
@@ -18599,6 +18611,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.ProviderGetFileDTO/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.ProviderGetFileDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.ProviderGetPresignedUploadUrlDTO/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.ProviderGetPresignedUploadUrlDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO"
|
||||
@@ -18607,6 +18623,14 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.S3FileServiceOptions/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.S3FileServiceOptions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx",
|
||||
"pathname": "/references/types/FileTypes/types/types.FileTypes.FileAccessPermission"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimInboundItems/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimInboundItems"
|
||||
@@ -22975,10 +22999,6 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.SavePaymentMethodOutput/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.SavePaymentMethodOutput"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.SessionOptions/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.SessionOptions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.StoreCreateReturnItem/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.StoreCreateReturnItem"
|
||||
@@ -24075,6 +24095,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/workflows/types/workflows.UnwrapWorkflowInputDataType/page.mdx",
|
||||
"pathname": "/references/workflows/types/workflows.UnwrapWorkflowInputDataType"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/workflows/types/workflows.Void/page.mdx",
|
||||
"pathname": "/references/workflows/types/workflows.Void"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/workflows/types/workflows.WorkflowData/page.mdx",
|
||||
"pathname": "/references/workflows/types/workflows.WorkflowData"
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createCartsStep({
|
||||
"currency_code": "kmf"
|
||||
"currency_code": "bnd"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -19,7 +19,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = retrieveCartStep({
|
||||
"id": "id_MO3xPcikYivsgJZw6"
|
||||
"id": "id_Hkk5wD99xf1l5rem"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateCartPromotionsStep({
|
||||
"id": "id_M6Afb7AEAZv7"
|
||||
"id": "id_ZSTaeCcPnPi3obG"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+4
-4
@@ -34,7 +34,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"id": [
|
||||
"id_7D8dzjcNGqe1PJBJ1T8"
|
||||
"id_KRHLrGTIOKya"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -61,7 +61,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"id": [
|
||||
"id_7D8dzjcNGqe1PJBJ1T8"
|
||||
"id_KRHLrGTIOKya"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -88,7 +88,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"id": [
|
||||
"id_7D8dzjcNGqe1PJBJ1T8"
|
||||
"id_KRHLrGTIOKya"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -116,7 +116,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": [
|
||||
"id_7D8dzjcNGqe1PJBJ1T8"
|
||||
"id_KRHLrGTIOKya"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createCustomerGroupsStep({
|
||||
"name": "Benjamin"
|
||||
"name": "Maybell"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
This documentation provides a reference to the `deleteFilesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step deletes one or more files using the installed
|
||||
[File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file). The files
|
||||
[File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). The files
|
||||
will be removed from the database and the storage.
|
||||
|
||||
## Example
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
This documentation provides a reference to the `uploadFilesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step uploads one or more files using the installed
|
||||
[File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).
|
||||
[File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file).
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
+2
-2
@@ -16,7 +16,7 @@ This documentation provides a reference to the `deleteFilesWorkflow`. It belongs
|
||||
This workflow deletes one or more files. It's used by the
|
||||
[Delete File Upload Admin API Route](https://docs.medusajs.com/api/admin#uploads\_deleteuploadsid).
|
||||
|
||||
The [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file) installed
|
||||
The [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file) installed
|
||||
in your application will be used to delete the file from storage.
|
||||
|
||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||
@@ -131,7 +131,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteFilesWorkflow","steps":[{"type":"step","name":"deleteFilesStep","description":"This step deletes one or more files using the installed\n[File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file). The files\nwill be removed from the database and the storage.","link":"../../../Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx","depth":1}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"deleteFilesWorkflow","steps":[{"type":"step","name":"deleteFilesStep","description":"This step deletes one or more files using the installed\n[File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). The files\nwill be removed from the database and the storage.","link":"../../../Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
This documentation provides a reference to the `uploadFilesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This workflow uploads one or more files using the installed
|
||||
[File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file). The workflow is used by the
|
||||
[File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). The workflow is used by the
|
||||
[Upload Files Admin API Route](https://docs.medusajs.com/api/admin#uploads\_postuploads).
|
||||
|
||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||
@@ -149,7 +149,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"uploadFilesWorkflow","steps":[{"type":"step","name":"uploadFilesStep","description":"This step uploads one or more files using the installed\n[File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).","link":"../../../Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx","depth":1}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"uploadFilesWorkflow","steps":[{"type":"step","name":"uploadFilesStep","description":"This step uploads one or more files using the installed\n[File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file).","link":"../../../Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createFulfillmentSets({
|
||||
"name": "Amina",
|
||||
"name": "Claudia",
|
||||
"type": "{value}"
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createServiceZonesStep({
|
||||
"name": "Karianne",
|
||||
"name": "Nathanial",
|
||||
"fulfillment_set_id": "{value}"
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
const data = createShippingOptionRulesStep({
|
||||
"data": [{
|
||||
"attribute": "{value}",
|
||||
"operator": "lt",
|
||||
"operator": "lte",
|
||||
"value": "{value}",
|
||||
"shipping_option_id": "{value}"
|
||||
}]
|
||||
|
||||
+3
-3
@@ -22,10 +22,10 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createShippingOptionsPriceSetsStep({
|
||||
"id": "id_SNWBZOx8vq0ZOtIk8h",
|
||||
"id": "id_CgpvAf1yZm3LU",
|
||||
"prices": [{
|
||||
"currency_code": "sos",
|
||||
"amount": 47
|
||||
"currency_code": "cop",
|
||||
"amount": 11
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createShippingProfilesStep({
|
||||
"name": "Andreanne",
|
||||
"name": "Deja",
|
||||
"type": "{value}"
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteShippingOptionRulesStep({
|
||||
"ids": [
|
||||
"id_5pDvmD1YtlPQjJK41W"
|
||||
"id_W9bsXpCN0scr6qF7"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateInventoryItemsStep({
|
||||
"id": "id_OQ1Kk5xDMmZWN"
|
||||
"id": "id_FWkpvVgjIWrefGLdGX"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -20,8 +20,8 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = validateInventoryDeleteStep({
|
||||
"inventory_items": [{
|
||||
"id": "id_mAPKO6c4Ac",
|
||||
"reserved_quantity": 26
|
||||
"id": "id_lmXs1HWLiKS",
|
||||
"reserved_quantity": 7
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -31,4 +31,4 @@ const data = notifyOnFailureStep([{
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"NotifyOnFailureStepInput","type":"[NotifyOnFailureStepInput](../../../../types/core_flows.NotifyOnFailureStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The notifications to send.","expandable":false,"children":[{"name":"to","type":"`string`","description":"The address to send the notification to, depending on\nthe channel. For example, the email address for the email channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel to send the notification through. For example, `email`.\nA [Notification Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/notification)\nmust be installed and configured for the specified channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"The ID of the template to use for the notification. This template ID may be defined\nin a third-party service used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>` \\| `null`","description":"The data to use in the notification template. This data may be used to personalize\nthe notification, such as the user's name or the order number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`string` \\| `null`","description":"The type of trigger that caused the notification to be sent. For example, `order_created`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string` \\| `null`","description":"The ID of the resource that triggered the notification. For example, the ID of the order\nthat triggered the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string` \\| `null`","description":"The type of the resource that triggered the notification. For example, `order`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`string` \\| `null`","description":"The ID of the user receiving the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`string` \\| `null`","description":"The ID of the original notification if it's being resent.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string` \\| `null`","description":"A key to ensure that the notification is sent only once. If the notification\nis sent multiple times, the key ensures that the notification is sent only once.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="notifyOnFailureStep"/>
|
||||
<TypeList types={[{"name":"NotifyOnFailureStepInput","type":"[NotifyOnFailureStepInput](../../../../types/core_flows.NotifyOnFailureStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The notifications to send.","expandable":false,"children":[{"name":"to","type":"`string`","description":"The address to send the notification to, depending on\nthe channel. For example, the email address for the email channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel to send the notification through. For example, `email`.\nA [Notification Module Provider](https://docs.medusajs.com/resources/architectural-modules/notification)\nmust be installed and configured for the specified channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"The ID of the template to use for the notification. This template ID may be defined\nin a third-party service used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>` \\| `null`","description":"The data to use in the notification template. This data may be used to personalize\nthe notification, such as the user's name or the order number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`string` \\| `null`","description":"The type of trigger that caused the notification to be sent. For example, `order_created`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string` \\| `null`","description":"The ID of the resource that triggered the notification. For example, the ID of the order\nthat triggered the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string` \\| `null`","description":"The type of the resource that triggered the notification. For example, `order`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`string` \\| `null`","description":"The ID of the user receiving the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`string` \\| `null`","description":"The ID of the original notification if it's being resent.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string` \\| `null`","description":"A key to ensure that the notification is sent only once. If the notification\nis sent multiple times, the key ensures that the notification is sent only once.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="notifyOnFailureStep"/>
|
||||
+2
-2
@@ -23,8 +23,8 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = addOrderTransactionStep({
|
||||
"order_id": "order_123",
|
||||
"amount": 14,
|
||||
"currency_code": "mur"
|
||||
"amount": 1,
|
||||
"currency_code": "jpy"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = cancelOrderChangeStep({
|
||||
"id": "id_PqTNZCr2IlkkxFm"
|
||||
"id": "id_FG3mczaeXDiTlu8YtsC"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = createOrderClaimsStep([{
|
||||
"order_id": "order_123",
|
||||
"type": "replace"
|
||||
"type": "refund"
|
||||
}])
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = declineOrderChangeStep({
|
||||
"id": "id_dMReuAuloGej2an"
|
||||
"id": "id_OCLr5Rmw2rddqtymU"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteClaimsStep({
|
||||
"ids": [
|
||||
"id_sKE8fUE7RnHiBr"
|
||||
"id_64vV39oKWKrXh"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteExchangesStep({
|
||||
"ids": [
|
||||
"id_YIxK05LliAOJd"
|
||||
"id_dxbz1cgTSarGCSU6nE"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderChangeActionsStep({
|
||||
"ids": [
|
||||
"id_IKPJjcTSbYs"
|
||||
"id_qCgJRmWDrwy1hwNr3G"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderChangesStep({
|
||||
"ids": [
|
||||
"id_HwkvTaSruUpqtTx"
|
||||
"id_lkcsQP9QhFS"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -20,7 +20,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderLineItems({
|
||||
"ids": [
|
||||
"id_mQuOuzLapdpF9C"
|
||||
"id_S5FVRAvoBP"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderShippingMethods({
|
||||
"ids": [
|
||||
"id_NLLD8xDj4YV"
|
||||
"id_9eUcyyMzeaJfTx"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteReturnsStep({
|
||||
"ids": [
|
||||
"id_zJNIz1dNb92ay"
|
||||
"id_CIzWOeim3oWz8aYt"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateOrderChangeActionsStep({
|
||||
"id": "id_C9WThWUfhvqIE"
|
||||
"id": "id_sGfxcI6kEUySt2Uyct8"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateOrderChangesStep({
|
||||
"id": "id_KEfsK0RWrLGliZQacRO"
|
||||
"id": "id_vTHM11g5uNH"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateOrderShippingMethodsStep({
|
||||
"id": "id_4dkBX4qJXX"
|
||||
"id": "id_mkcw0ExOX8cvEXTh"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -21,7 +21,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateReturnsStep({
|
||||
"id": "id_EzOlr8oGR1hYas4n6"
|
||||
"id": "id_VWpi4lcx9l4M5e1K"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await cancelOrderChangeWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_nviCvZT41EQrz"
|
||||
"id": "id_UuNMMZNjyP"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await cancelOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_nviCvZT41EQrz"
|
||||
"id": "id_UuNMMZNjyP"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await cancelOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_nviCvZT41EQrz"
|
||||
"id": "id_UuNMMZNjyP"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = cancelOrderChangeWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_nviCvZT41EQrz"
|
||||
"id": "id_UuNMMZNjyP"
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await createOrderChangeActionsWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"action": "RECEIVE_DAMAGED_RETURN_ITEM"
|
||||
"action": "RECEIVE_RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await createOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"action": "RECEIVE_DAMAGED_RETURN_ITEM"
|
||||
"action": "RECEIVE_RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await createOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"action": "RECEIVE_DAMAGED_RETURN_ITEM"
|
||||
"action": "RECEIVE_RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = createOrderChangeActionsWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"action": "RECEIVE_DAMAGED_RETURN_ITEM"
|
||||
"action": "RECEIVE_RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await declineOrderChangeWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_LNQkTPqtZ0KU5E"
|
||||
"id": "id_UnDe8FRrhUSN3isnYw"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await declineOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_LNQkTPqtZ0KU5E"
|
||||
"id": "id_UnDe8FRrhUSN3isnYw"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await declineOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_LNQkTPqtZ0KU5E"
|
||||
"id": "id_UnDe8FRrhUSN3isnYw"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = declineOrderChangeWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_LNQkTPqtZ0KU5E"
|
||||
"id": "id_UnDe8FRrhUSN3isnYw"
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -40,7 +40,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ERnWVNhBxzO"
|
||||
"id_PIgI4XHRXgS37LE70OEH"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -67,7 +67,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ERnWVNhBxzO"
|
||||
"id_PIgI4XHRXgS37LE70OEH"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -94,7 +94,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ERnWVNhBxzO"
|
||||
"id_PIgI4XHRXgS37LE70OEH"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -122,7 +122,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ERnWVNhBxzO"
|
||||
"id_PIgI4XHRXgS37LE70OEH"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+4
-4
@@ -40,7 +40,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_Z1lIBRWAbuxnqjt"
|
||||
"id_9VrlIRZvXbUgIGB"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -67,7 +67,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_Z1lIBRWAbuxnqjt"
|
||||
"id_9VrlIRZvXbUgIGB"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -94,7 +94,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_Z1lIBRWAbuxnqjt"
|
||||
"id_9VrlIRZvXbUgIGB"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -122,7 +122,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_Z1lIBRWAbuxnqjt"
|
||||
"id_9VrlIRZvXbUgIGB"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -23,14 +23,14 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = throwUnlessStatusIsNotPaid({
|
||||
"paymentCollection": {
|
||||
"id": "id_4UNzcT3YjExek7j9",
|
||||
"currency_code": "clp",
|
||||
"id": "id_5zEyQaVnzNX",
|
||||
"currency_code": "eur",
|
||||
"amount": {
|
||||
"numeric": 42
|
||||
"numeric": 37
|
||||
},
|
||||
"status": "authorized",
|
||||
"status": "canceled",
|
||||
"payment_providers": [{
|
||||
"id": "id_iHLGpCBb8mNvenJWF",
|
||||
"id": "id_02OlulUtDdP",
|
||||
"is_enabled": true
|
||||
}]
|
||||
}
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await updateOrderChangeActionsWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_Mx0m5oHJ7lFvj"
|
||||
"id": "id_1i1GZaQvfq8ZEXv3"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await updateOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_Mx0m5oHJ7lFvj"
|
||||
"id": "id_1i1GZaQvfq8ZEXv3"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await updateOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_Mx0m5oHJ7lFvj"
|
||||
"id": "id_1i1GZaQvfq8ZEXv3"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = updateOrderChangeActionsWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"id": "id_Mx0m5oHJ7lFvj"
|
||||
"id": "id_1i1GZaQvfq8ZEXv3"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await updateOrderChangesWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_XpjiY1q0XfWPNar5dYmM"
|
||||
"id": "id_EVlJECAxoiufCVXxXP1"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await updateOrderChangesWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_XpjiY1q0XfWPNar5dYmM"
|
||||
"id": "id_EVlJECAxoiufCVXxXP1"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await updateOrderChangesWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_XpjiY1q0XfWPNar5dYmM"
|
||||
"id": "id_EVlJECAxoiufCVXxXP1"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = updateOrderChangesWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"id": "id_XpjiY1q0XfWPNar5dYmM"
|
||||
"id": "id_EVlJECAxoiufCVXxXP1"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = refundPaymentsStep({
|
||||
"payment_id": "{value}",
|
||||
"amount": 47
|
||||
"amount": 49
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -24,8 +24,8 @@ const myWorkflow = createWorkflow(
|
||||
const data = createPaymentSessionStep({
|
||||
"payment_collection_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"amount": 26,
|
||||
"currency_code": "ern"
|
||||
"amount": 33,
|
||||
"currency_code": "lsl"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deletePaymentSessionsStep({
|
||||
"ids": [
|
||||
"id_vFYHSMJk2GKVmqPXDT"
|
||||
"id_rMEluti2uqjxy"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateRefundReasonsStep({
|
||||
"id": "id_t4xipdA1qw39gjb"
|
||||
"id": "id_xaxnbF2JQfc384"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = validatePriceListsStep({
|
||||
"id": "id_HOUA7oCPCDc2EHMg"
|
||||
"id": "id_BBpQT3EpP1LBd7"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createCollectionsStep([{
|
||||
"title": "agnitio"
|
||||
"title": "sint"
|
||||
}])
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
This documentation provides a reference to the `generateProductCsvStep`. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step generates a CSV file that exports products. The CSV
|
||||
file is created and stored using the registered [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).
|
||||
file is created and stored using the registered [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file).
|
||||
|
||||
## Example
|
||||
|
||||
@@ -34,4 +34,4 @@ const data = generateProductCsvStep(products)
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"GenerateProductCsvStepOutput","type":"[GenerateProductCsvStepOutput](../../../../types/core_flows.GenerateProductCsvStepOutput/page.mdx)","optional":false,"defaultValue":"","description":"The export's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"The name of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="generateProductCsvStep"/>
|
||||
<TypeList types={[{"name":"GenerateProductCsvStepOutput","type":"[GenerateProductCsvStepOutput](../../../../types/core_flows.GenerateProductCsvStepOutput/page.mdx)","optional":false,"defaultValue":"","description":"The export's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"The name of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="generateProductCsvStep"/>
|
||||
+1
-1
@@ -254,7 +254,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"exportProductsWorkflow","steps":[{"type":"step","name":"getAllProductsStep","description":"This step retrieves all products matching a set of filters.","link":"../../../Steps_Product/functions/core_flows.Product.Steps_Product.getAllProductsStep/page.mdx","depth":1},{"type":"step","name":"notifyOnFailureStep","description":"This step sends one or more notification when a workflow fails. This\nstep can be used in the beginning of a workflow so that, when the workflow fails,\nthe step's compensation function is triggered to send the notification.","link":"../../../../Notification/Steps_Notification/functions/core_flows.Notification.Steps_Notification.notifyOnFailureStep/page.mdx","depth":2},{"type":"step","name":"generateProductCsvStep","description":"This step generates a CSV file that exports products. The CSV\nfile is created and stored using the registered [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).","link":"../../../Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"sendNotificationsStep","description":"This step sends one or more notifications.","link":"../../../../Notification/Steps_Notification/functions/core_flows.Notification.Steps_Notification.sendNotificationsStep/page.mdx","depth":5}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"exportProductsWorkflow","steps":[{"type":"step","name":"getAllProductsStep","description":"This step retrieves all products matching a set of filters.","link":"../../../Steps_Product/functions/core_flows.Product.Steps_Product.getAllProductsStep/page.mdx","depth":1},{"type":"step","name":"notifyOnFailureStep","description":"This step sends one or more notification when a workflow fails. This\nstep can be used in the beginning of a workflow so that, when the workflow fails,\nthe step's compensation function is triggered to send the notification.","link":"../../../../Notification/Steps_Notification/functions/core_flows.Notification.Steps_Notification.notifyOnFailureStep/page.mdx","depth":2},{"type":"step","name":"generateProductCsvStep","description":"This step generates a CSV file that exports products. The CSV\nfile is created and stored using the registered [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file).","link":"../../../Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"sendNotificationsStep","description":"This step sends one or more notifications.","link":"../../../../Notification/Steps_Notification/functions/core_flows.Notification.Steps_Notification.sendNotificationsStep/page.mdx","depth":5}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ This workflow starts a product import from a CSV file in the background. It's us
|
||||
You can use this workflow within your custom workflows, allowing you to wrap custom logic around product import.
|
||||
For example, you can import products from another system.
|
||||
|
||||
The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.medusajs.com/resources/infrastructure-modules/workflow-engine).
|
||||
The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.medusajs.com/resources/architectural-modules/workflow-engine).
|
||||
The below example shows how to confirm the import.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/b9edc066c8486e8ec52e4f505968db1c558bc7b8/packages/core/core-flows/src/product/workflows/import-products.ts#L92" />
|
||||
|
||||
+2
-2
@@ -21,8 +21,8 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = updatePromotionsValidationStep({
|
||||
"promotionsData": [{
|
||||
"id": "id_V6oi8Fm1P1EG1mwgKlB",
|
||||
"status": "active"
|
||||
"id": "id_ZiYi7244rYQuZ",
|
||||
"status": "inactive"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createStockLocations({
|
||||
"name": "Brice"
|
||||
"name": "Greta"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -165,7 +165,7 @@ class MyFileProviderService extends AbstractFileProviderService {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"file","type":"[ProviderUploadFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx)","description":"The file to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upload"/>
|
||||
<TypeList types={[{"name":"file","type":"[ProviderUploadFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx)","description":"The file to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upload"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
+48
-2
@@ -57,7 +57,7 @@ const [file] = await fileModuleService.createFiles([{
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)[]","description":"The files to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)[]","description":"The files to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -79,7 +79,7 @@ const file = await fileModuleService.createFiles({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)","description":"The file to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)","description":"The file to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -87,6 +87,52 @@ const file = await fileModuleService.createFiles({
|
||||
|
||||
___
|
||||
|
||||
## getUploadFileUrls
|
||||
|
||||
### getUploadFileUrls(data, sharedContext?): Promise<[UploadFileUrlDTO](../../../types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx)>
|
||||
|
||||
This method gets the upload URL for a file.
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const uploadInfo = await fileModuleService.getUploadFileUrls({
|
||||
filename: "product.png",
|
||||
mimeType: "image/png",
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[GetUploadFileUrlDTO](../../../types/FileTypes/interfaces/types.FileTypes.GetUploadFileUrlDTO/page.mdx)","description":"The file information to get the upload URL for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file to be uploaded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the file to be uploaded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file to be uploaded. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[UploadFileUrlDTO](../../../types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The upload URL for the file.","expandable":false,"children":[{"name":"url","type":"`string`","description":"The URL of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key allowing you to later\nidentify the file in the third-party\nsystem. For example, the S3 Module Provider\nreturns the file's key in S3, whereas the\nLocal File Module Provider returns the file's\npath.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
### getUploadFileUrls(data, sharedContext?): Promise<[UploadFileUrlDTO](../../../types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx)[]>
|
||||
|
||||
This method uploads files to the designated file storage system.
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const [uploadInfo] = await fileModuleService.getUploadFileUrls([{
|
||||
filename: "product.png",
|
||||
mimeType: "image/png",
|
||||
}])
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[GetUploadFileUrlDTO](../../../types/FileTypes/interfaces/types.FileTypes.GetUploadFileUrlDTO/page.mdx)[]","description":"The file information to get the upload URL for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file to be uploaded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the file to be uploaded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file to be uploaded. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[UploadFileUrlDTO](../../../types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The upload URLs for the files.","expandable":false,"children":[{"name":"UploadFileUrlDTO[]","type":"[UploadFileUrlDTO](../../../types/FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"The URL of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key allowing you to later\nidentify the file in the third-party\nsystem. For example, the S3 Module Provider\nreturns the file's key in S3, whereas the\nLocal File Module Provider returns the file's\npath.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteFiles
|
||||
|
||||
### deleteFiles(ids, sharedContext?): Promise<void>
|
||||
|
||||
+12
@@ -423,6 +423,18 @@ sdk.admin.draftOrder.removeShippingMethod("order_123", "action_123")
|
||||
|
||||
___
|
||||
|
||||
## removeShippingMethod
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingMethodId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","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/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeShippingMethod"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminDraftOrderPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"draft_order_preview","type":"[AdminDraftOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderPreview/page.mdx)","description":"The details of the preview on the draft order.","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":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","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":"status","type":"`string`","description":"The order's status.","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 ordeLine truncated
|
||||
|
||||
___
|
||||
|
||||
## updateShippingMethod
|
||||
|
||||
This method updates a shipping method in a draft order. It sends a request to the
|
||||
|
||||
+1
-1
@@ -100,7 +100,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"query","type":"[AdminGetPromotionsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search for a promotion by its searchable","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by promotion code.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign_id","type":"`string` \\| `string`[]","description":"Filter by campaign ID to retrieve promotions by campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"`object`","description":"Filter by the promotion's application method.","optional":true,"defaultValue":"","expandable":false,"childLine truncated
|
||||
<TypeList types={[{"name":"query","type":"[AdminGetPromotionsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search for a promotion by its searchable","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by promotion code.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign_id","type":"`string` \\| `string`[]","description":"Filter by campaign ID to retrieve promotions by campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"`object`","description":"Filter by the promotion's application method.","optional":true,"defaultValue":"","expandable":false,"childLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# removeShippingMethod
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingMethodId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","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/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeShippingMethod"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminDraftOrderPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"draft_order_preview","type":"[AdminDraftOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderPreview/page.mdx)","description":"The details of the preview on the draft order.","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":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","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":"status","type":"`string`","description":"The order's status.","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 ordeLine truncated
|
||||
+1
-1
@@ -47,7 +47,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"query","type":"[AdminGetPromotionsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search for a promotion by its searchable","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by promotion code.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign_id","type":"`string` \\| `string`[]","description":"Filter by campaign ID to retrieve promotions by campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"`object`","description":"Filter by the promotion's application method.","optional":true,"defaultValue":"","expandable":false,"childLine truncated
|
||||
<TypeList types={[{"name":"query","type":"[AdminGetPromotionsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search for a promotion by its searchable","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by promotion code.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign_id","type":"`string` \\| `string`[]","description":"Filter by campaign ID to retrieve promotions by campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"`object`","description":"Filter by the promotion's application method.","optional":true,"defaultValue":"","expandable":false,"childLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
@@ -16,6 +16,7 @@ import { TypeList } from "docs-ui"
|
||||
- [removeActionItem](../../DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionItem/page.mdx)
|
||||
- [removeActionShippingMethod](../../DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionShippingMethod/page.mdx)
|
||||
- [removePromotions](../../DraftOrder/methods/js_sdk.admin.DraftOrder.removePromotions/page.mdx)
|
||||
- [removeShippingMethod](../../DraftOrder/methods/js_sdk.admin.DraftOrder.removeShippingMethod/page.mdx)
|
||||
- [requestEdit](../../DraftOrder/methods/js_sdk.admin.DraftOrder.requestEdit/page.mdx)
|
||||
- [retrieve](../../DraftOrder/methods/js_sdk.admin.DraftOrder.retrieve/page.mdx)
|
||||
- [update](../../DraftOrder/methods/js_sdk.admin.DraftOrder.update/page.mdx)
|
||||
|
||||
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"matcher","type":"`string` \\| `RegExp`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx) \\| [MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"@deprecated. Instead use MiddlewareRoute.methods","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"methods","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bodyParser","type":"[ParserConfig](../medusa.ParserConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"sizeLimit","type":"`string` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preserveRawBody","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"middlewares","type":"[MiddlewareFunction](../medusa.MiddlewareFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MiddlewareRoute"/>
|
||||
<TypeList types={[{"name":"matcher","type":"`string` \\| `RegExp`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx) \\| [MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"@deprecated. Instead use MiddlewareRoute.methods","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"methods","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bodyParser","type":"[ParserConfig](../medusa.ParserConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"sizeLimit","type":"`string` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preserveRawBody","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additionalDataValidator","type":"`ZodRawShape`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"middlewares","type":"[MiddlewareFunction](../medusa.MiddlewareFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MiddlewareRoute"/>
|
||||
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"errorHandler","type":"`false` \\| [MedusaErrorHandlerFunction](../medusa.MedusaErrorHandlerFunction/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"routes","type":"[MiddlewareRoute](../medusa.MiddlewareRoute/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"matcher","type":"`string` \\| `RegExp`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx) \\| [MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"@deprecated. Instead use MiddlewareRoute.methods","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"methods","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bodyParser","type":"[ParserConfig](../medusa.ParserConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"middlewares","type":"[MiddlewareFunction](../medusa.MiddlewareFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MiddlewaresConfig"/>
|
||||
<TypeList types={[{"name":"errorHandler","type":"`false` \\| [MedusaErrorHandlerFunction](../medusa.MedusaErrorHandlerFunction/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"routes","type":"[MiddlewareRoute](../medusa.MiddlewareRoute/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"matcher","type":"`string` \\| `RegExp`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx) \\| [MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"@deprecated. Instead use MiddlewareRoute.methods","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"methods","type":"[MiddlewareVerb](../medusa.MiddlewareVerb/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bodyParser","type":"[ParserConfig](../medusa.ParserConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"`ZodRawShape`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"middlewares","type":"[MiddlewareFunction](../medusa.MiddlewareFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MiddlewaresConfig"/>
|
||||
-4
@@ -267,10 +267,6 @@ module.exports = defineConfig({
|
||||
})
|
||||
```
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"name","type":"`string`","description":"The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resave","type":"`boolean`","description":"Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rolling","type":"`boolean`","description":"Whether the session identifier cookie should be force-set on every response. The default value is `false`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveUninitialized","type":"`boolean`","description":"Whether a session that is \"uninitialized\" is forced to be saved to the store. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"secret","type":"`string`","description":"The secret to sign the session ID cookie. By default, the value of `http.cookieSecret` is used.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"Used when calculating the `Expires` `Set-Cookie` attribute of cookies. By default, its value is `10 * 60 * 60 * 1000`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="sessionOptions"/>
|
||||
|
||||
### workerMode
|
||||
|
||||
Configure the application's worker mode.
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
Essential configurations related to the Medusa application, such as database and CORS configurations.
|
||||
|
||||
<TypeList types={[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../medusa_config.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but will tLine truncated
|
||||
<TypeList types={[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../medusa_config.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but will tLine truncated
|
||||
@@ -216,7 +216,6 @@ import { TypeList } from "docs-ui"
|
||||
- [RetrievePaymentOutput](../../types/interfaces/types.RetrievePaymentOutput/page.mdx)
|
||||
- [SavePaymentMethodInput](../../types/interfaces/types.SavePaymentMethodInput/page.mdx)
|
||||
- [SavePaymentMethodOutput](../../types/interfaces/types.SavePaymentMethodOutput/page.mdx)
|
||||
- [SessionOptions](../../types/interfaces/types.SessionOptions/page.mdx)
|
||||
- [StoreCreateReturnItem](../../types/interfaces/types.StoreCreateReturnItem/page.mdx)
|
||||
- [StoreCreateReturnShipping](../../types/interfaces/types.StoreCreateReturnShipping/page.mdx)
|
||||
- [UpdateAccountHolderInput](../../types/interfaces/types.UpdateAccountHolderInput/page.mdx)
|
||||
|
||||
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"__type","type":"`symbol`","description":"","optional":false,"defaultValue":"MedusaModuleType","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Link"/>
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### addModule
|
||||
@@ -38,7 +44,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -48,7 +54,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismiss"/>
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismiss"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -58,7 +64,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -68,7 +74,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="restore"/>
|
||||
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="restore"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -78,7 +84,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"asLinkDefinition","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"asLinkDefinition","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
+6
@@ -27,6 +27,7 @@ const promotions = await promotionModuleService.createPromotions([
|
||||
{
|
||||
code: "50OFF",
|
||||
type: "standard",
|
||||
status: "active",
|
||||
application_method: {
|
||||
type: "percentage",
|
||||
target_type: "items",
|
||||
@@ -36,6 +37,7 @@ const promotions = await promotionModuleService.createPromotions([
|
||||
{
|
||||
code: "FREESHIPPING",
|
||||
type: "standard",
|
||||
status: "active",
|
||||
application_method: {
|
||||
type: "percentage",
|
||||
target_type: "shipping_methods",
|
||||
@@ -45,6 +47,7 @@ const promotions = await promotionModuleService.createPromotions([
|
||||
{
|
||||
code: "BUY2GET1",
|
||||
type: "buyget",
|
||||
status: "active",
|
||||
application_method: {
|
||||
type: "fixed",
|
||||
target_type: "items",
|
||||
@@ -80,6 +83,7 @@ This method creates a promotion.
|
||||
const promotionA = await promotionModuleService.createPromotions({
|
||||
code: "50OFF",
|
||||
type: "standard",
|
||||
status: "active",
|
||||
application_method: {
|
||||
type: "percentage",
|
||||
target_type: "items",
|
||||
@@ -90,6 +94,7 @@ const promotionA = await promotionModuleService.createPromotions({
|
||||
const promotionB = await promotionModuleService.createPromotions({
|
||||
code: "FREESHIPPING",
|
||||
type: "standard",
|
||||
status: "active",
|
||||
application_method: {
|
||||
type: "percentage",
|
||||
target_type: "shipping_methods",
|
||||
@@ -100,6 +105,7 @@ const promotionB = await promotionModuleService.createPromotions({
|
||||
const promotionC = await promotionModuleService.createPromotions({
|
||||
code: "BUY2GET1",
|
||||
type: "buyget",
|
||||
status: "active",
|
||||
application_method: {
|
||||
type: "fixed",
|
||||
target_type: "items",
|
||||
|
||||
+1
-1
@@ -6,4 +6,4 @@ Admin dashboard configurations.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"path","type":"`/${string}`","description":"The path to the admin dashboard. The default value is `/app`.\n\nThe value cannot be one of the reserved paths:\n- `/admin`\n- `/store`\n- `/auth`\n- `/`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"disable","type":"`boolean`","description":"Whether to disable the admin dashboard. If set to `true`, the admin dashboard is disabled,\nin both development and production environments. The default value is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"backendUrl","type":"`string`","description":"The URL of your Medusa application. Defaults to the browser origin. This is useful to set when running the admin on a separate domain.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"storefrontUrl","type":"`string`","description":"The URL of your Medusa storefront application. This will help generate links from the admin\nto provide to customers to complete any processes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"vite","type":"(`config`: `InlineConfig`) => `InlineConfig`","description":"Configure the Vite configuration for the admin dashboard. This function receives the default Vite configuration\nand returns the modified configuration. The default value is `undefined`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminOptions"/>
|
||||
<TypeList types={[{"name":"path","type":"`/${string}`","description":"The path to the admin dashboard. The default value is `/app`.\n\nThe value cannot be one of the reserved paths:\n- `/admin`\n- `/store`\n- `/auth`\n- `/`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"disable","type":"`boolean`","description":"Whether to disable the admin dashboard. If set to `true`, the admin dashboard is disabled,\nin both development and production environments. The default value is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"backendUrl","type":"`string`","description":"The URL of your Medusa application. Defaults to the browser origin. This is useful to set when running the admin on a separate domain.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"storefrontUrl","type":"`string`","description":"The URL of your Medusa storefront application. This will help generate links from the admin\nto provide to customers to complete any processes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"outDir","type":"`string`","description":"The directory where the admin build is output. This is where the build process places the generated files.\nThe default value is `./build`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"vite","type":"(`config`: `InlineConfig`) => `InlineConfig`","description":"Configure the Vite configuration for the admin dashboard. This function receives the default Vite configuration\nand returns the modified configuration. The default value is `undefined`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminOptions"/>
|
||||
+12
-5
@@ -2,20 +2,27 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# ConfigModule
|
||||
|
||||
The configurations for your Medusa application are in `medusa-config.js` located in the root of your Medusa project. The configurations include configurations for database, modules, and more.
|
||||
The configurations for your Medusa application are set in `medusa-config.ts` located in the root of your Medusa project. The configurations include configurations for database, modules, and more.
|
||||
|
||||
`medusa-config.js` exports the value returned by the `defineConfig` utility function imported from `@medusajs/utils`.
|
||||
:::note
|
||||
|
||||
Some Medusa configurations are set through environment variables, which you can find in [this documentation](https://docs.medusajs.com/learn/fundamentals/environment-variables#predefined-medusa-environment-variables).
|
||||
|
||||
:::
|
||||
|
||||
`medusa-config.ts` exports the value returned by the `defineConfig` utility function imported from `@medusajs/framework/utils`.
|
||||
|
||||
`defineConfig` accepts as a parameter an object with the following properties:
|
||||
|
||||
- [projectConfig](page.mdx#projectconfig) (required): An object that holds general configurations related to the Medusa application, such as database or CORS configurations.
|
||||
- [plugins](page.mdx#plugins): An array of strings or objects that hold the configurations of the plugins installed in the Medusa application.
|
||||
- [admin](page.mdx#admin): An object that holds admin-related configurations.
|
||||
- [modules](page.mdx#modules): An object that configures the Medusa application's modules.
|
||||
- [featureFlags](page.mdx#featureflags): An object that enables or disables features guarded by a feature flag.
|
||||
|
||||
For example:
|
||||
|
||||
```js title="medusa-config.js"
|
||||
```ts title="medusa-config.ts"
|
||||
module.exports = defineConfig({
|
||||
projectConfig: {
|
||||
// ...
|
||||
@@ -36,7 +43,7 @@ module.exports = defineConfig({
|
||||
|
||||
## Environment Variables
|
||||
|
||||
It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.js`.
|
||||
It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.ts`.
|
||||
|
||||
During development, you can set your environment variables in the `.env` file at the root of your Medusa application project. In production,
|
||||
setting the environment variables depends on the hosting provider.
|
||||
@@ -45,4 +52,4 @@ setting the environment variables depends on the hosting provider.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"projectConfig","type":"[ProjectConfigOptions](../types.CommonTypes.ProjectConfigOptions/page.mdx)","description":"This property holds essential configurations related to the Medusa application, such as database and CORS configurations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authMethodsPerActLine truncated
|
||||
<TypeList types={[{"name":"projectConfig","type":"[ProjectConfigOptions](../types.CommonTypes.ProjectConfigOptions/page.mdx)","description":"This property holds essential configurations related to the Medusa application, such as database and CORS configurations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authMethodsPerActLine truncated
|
||||
+1
-1
@@ -6,4 +6,4 @@ Essential configurations related to the Medusa application, such as database and
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but wiLine truncated
|
||||
<TypeList types={[{"name":"http","type":"`object`","description":"This property configures the application's http-specific settings.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that Medusa tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa application's API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret`. However, in production, if this configuration is not set, an\nerror is thrown and the application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).\n\nIf not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret`. However, in production, if this configuration is not set, an error is thrown and\nthe application crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.\nLearn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but wiLine truncated
|
||||
+1
-1
@@ -6,4 +6,4 @@ Options to pass to `express-session`.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"name","type":"`string`","description":"The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resave","type":"`boolean`","description":"Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rolling","type":"`boolean`","description":"Whether the session identifier cookie should be force-set on every response. The default value is `false`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveUninitialized","type":"`boolean`","description":"Whether a session that is \"uninitialized\" is forced to be saved to the store. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"secret","type":"`string`","description":"The secret to sign the session ID cookie. By default, the value of `http.cookieSecret` is used.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"Used when calculating the `Expires` `Set-Cookie` attribute of cookies. By default, its value is `10 * 60 * 60 * 1000`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SessionOptions"/>
|
||||
<TypeList types={[{"name":"name","type":"`string`","description":"The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resave","type":"`boolean`","description":"Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rolling","type":"`boolean`","description":"Whether the session identifier cookie should be force-set on every response. The default value is `false`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveUninitialized","type":"`boolean`","description":"Whether a session that is \"uninitialized\" is forced to be saved to the store. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"secret","type":"`string`","description":"The secret to sign the session ID cookie. By default, the value of `http.cookieSecret` is used.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"Used when calculating the `Expires` `Set-Cookie` attribute of cookies. By default, its value is `10 * 60 * 60 * 1000`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dynamodbOptions","type":"`object`","description":"Specify the options for storing session data to dynamoDB. Make\nsure to install the following dependencies first.\n\n- @aws-sdk/client-dynamodb@^3.218.0\n- connect-dynamodb@^3.0.5","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"clientOptions","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"endpoint","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"table","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prefix","type":"`string`","description":"Defaults to 'sess:'","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hashKey","type":"`string`","description":"Defaults to 'id'","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"readCapacityUnits","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"writeCapacityUnits","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"specialKeys","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"skipThrowMissingSpecialKeys","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialized","type":"`boolean`","description":"Disable initialization.\nUseful if the table already exists or if you want to skip existence checks in a serverless environment such as AWS Lambda.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SessionOptions"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ The File to be created.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CreateFileDTO"/>
|
||||
<TypeList types={[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CreateFileDTO"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# GetUploadFileUrlDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"filename","type":"`string`","description":"The name of the file to be uploaded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the file to be uploaded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file to be uploaded. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="GetUploadFileUrlDTO"/>
|
||||
+46
-2
@@ -22,7 +22,7 @@ const [file] = await fileModuleService.createFiles([{
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../types.FileTypes.CreateFileDTO/page.mdx)[]","description":"The files to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../types.FileTypes.CreateFileDTO/page.mdx)[]","description":"The files to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -44,12 +44,56 @@ const file = await fileModuleService.createFiles({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../types.FileTypes.CreateFileDTO/page.mdx)","description":"The file to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../types.FileTypes.CreateFileDTO/page.mdx)","description":"The file to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string (For example, base64).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[FileDTO](../types.FileTypes.FileDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The created file.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the file. You can use this ID later to\nretrieve or delete the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
|
||||
### getUploadFileUrls
|
||||
|
||||
`**getUploadFileUrls**(data, sharedContext?): Promise<[UploadFileUrlDTO](../types.FileTypes.UploadFileUrlDTO/page.mdx)>`
|
||||
|
||||
This method gets the upload URL for a file.
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const uploadInfo = await fileModuleService.getUploadFileUrls({
|
||||
filename: "product.png",
|
||||
mimeType: "image/png",
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[GetUploadFileUrlDTO](../types.FileTypes.GetUploadFileUrlDTO/page.mdx)","description":"The file information to get the upload URL for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file to be uploaded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the file to be uploaded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file to be uploaded. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[UploadFileUrlDTO](../types.FileTypes.UploadFileUrlDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The upload URL for the file.","expandable":false,"children":[{"name":"url","type":"`string`","description":"The URL of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key allowing you to later\nidentify the file in the third-party\nsystem. For example, the S3 Module Provider\nreturns the file's key in S3, whereas the\nLocal File Module Provider returns the file's\npath.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
`**getUploadFileUrls**(data, sharedContext?): Promise<[UploadFileUrlDTO](../types.FileTypes.UploadFileUrlDTO/page.mdx)[]>`
|
||||
|
||||
This method uploads files to the designated file storage system.
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const [uploadInfo] = await fileModuleService.getUploadFileUrls([{
|
||||
filename: "product.png",
|
||||
mimeType: "image/png",
|
||||
}])
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[GetUploadFileUrlDTO](../types.FileTypes.GetUploadFileUrlDTO/page.mdx)[]","description":"The file information to get the upload URL for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file to be uploaded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the file to be uploaded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file to be uploaded. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[UploadFileUrlDTO](../types.FileTypes.UploadFileUrlDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The upload URLs for the files.","expandable":false,"children":[{"name":"UploadFileUrlDTO[]","type":"[UploadFileUrlDTO](../types.FileTypes.UploadFileUrlDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"The URL of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key allowing you to later\nidentify the file in the third-party\nsystem. For example, the S3 Module Provider\nreturns the file's key in S3, whereas the\nLocal File Module Provider returns the file's\npath.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getUploadFileUrls"/>
|
||||
|
||||
### deleteFiles
|
||||
|
||||
`**deleteFiles**(ids, sharedContext?): Promise<void>`
|
||||
|
||||
+14
-1
@@ -10,7 +10,7 @@ This method is used to upload a file
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"file","type":"[ProviderUploadFileDTO](../types.FileTypes.ProviderUploadFileDTO/page.mdx)","description":"The contents and metadata of the file.\nAmong the file’s details, you can access the file’s path in the `path` property of the file object.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upload"/>
|
||||
<TypeList types={[{"name":"file","type":"[ProviderUploadFileDTO](../types.FileTypes.ProviderUploadFileDTO/page.mdx)","description":"The contents and metadata of the file.\nAmong the file’s details, you can access the file’s path in the `path` property of the file object.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upload"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -41,3 +41,16 @@ If your file service doesn’t perform or offer a similar functionality, you can
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"The presigned URL to download the file","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getPresignedDownloadUrl"/>
|
||||
|
||||
### getPresignedUploadUrl
|
||||
|
||||
This method is used to get a presigned upload URL for a file.
|
||||
If the file provider does not support direct upload, an exception will be thrown when calling this method.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"fileData","type":"[ProviderGetPresignedUploadUrlDTO](../types.FileTypes.ProviderGetPresignedUploadUrlDTO/page.mdx)","description":"The details of the file to get a presigned upload URL for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The filename of the file to get a presigned upload URL for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the file to get a presigned upload URL for.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file to get a presigned upload URL for.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expiresIn","type":"`number`","description":"The validity of the presigned upload URL in seconds.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getPresignedUploadUrl"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[ProviderFileResultDTO](../types.FileTypes.ProviderFileResultDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The presigned URL and file key to upload the file to","expandable":false,"children":[{"name":"url","type":"`string`","description":"The file's URL that users or systems\ncan use to access the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key allowing you to later\nidentify the file in the third-party\nsystem. For example, the S3 Module Provider\nreturns the file's key in S3, whereas the\nLocal File Module Provider returns the file's\npath.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getPresignedUploadUrl"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProviderGetPresignedUploadUrlDTO
|
||||
|
||||
The details of the file to get a presigned upload URL for.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"filename","type":"`string`","description":"The filename of the file to get a presigned upload URL for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the file to get a presigned upload URL for.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file to get a presigned upload URL for.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expiresIn","type":"`number`","description":"The validity of the presigned upload URL in seconds.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderGetPresignedUploadUrlDTO"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ The details of the file to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderUploadFileDTO"/>
|
||||
<TypeList types={[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderUploadFileDTO"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# UploadFileUrlDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"url","type":"`string`","description":"The URL of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key allowing you to later\nidentify the file in the third-party\nsystem. For example, the S3 Module Provider\nreturns the file's key in S3, whereas the\nLocal File Module Provider returns the file's\npath.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UploadFileUrlDTO"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# FileAccessPermission
|
||||
|
||||
**FileAccessPermission**: `"public"` \| `"private"`
|
||||
|
||||
The access level of the file.
|
||||
+1
-1
@@ -6,4 +6,4 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search for a promotion by its searchable","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by promotion code.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/types.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign_id","type":"`string` \\| `string`[]","description":"Filter by campaign ID to retrieve promotions by campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"`object`","description":"Filter by the promotion's application method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string` \\| `string`[]","description":"Filter by the promotion's application method currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Filter by the promotion's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[Line truncated
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search for a promotion by its searchable","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by promotion code.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/types.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign_id","type":"`string` \\| `string`[]","description":"Filter by campaign ID to retrieve promotions by campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"`object`","description":"Filter by the promotion's application method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string` \\| `string`[]","description":"Filter by the promotion's application method currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Filter by the promotion's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[Line truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"steps","type":"`Record<string, [AdminWorkflowExecutionStep](../types.HttpTypes.AdminWorkflowExecutionStep/page.mdx)>`","description":"The details of the workflow execution's steps.\nThe key is the step's ID, and the value is the step's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"[WorkflowExecutionFn](../types.HttpTypes.WorkflowExecutionFn/page.mdx)","description":"The invoke function of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"state","type":"[TransactionStepState](../../types/types.HttpTypes.TransactionStepState/page.mdx)","description":"The state of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[TransactionStepStatus](../../types/types.HttpTypes.TransactionStepStatus/page.mdx)","description":"The status of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"definition","type":"[WorkflowExecutionDefinition](../types.HttpTypes.WorkflowExecutionDefinition/page.mdx)","description":"The definition of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"async","type":"`boolean`","description":"If true, the step is executed asynchronously. This means that the workflow will not wait for the response of this step.\nAsync steps require to have their responses set using `setStepSuccess` or `setStepFailure`, unless it is combined with `backgroundExecution: true`.\nIf combined with a timeout, and any response is not set within that interval, the step will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateAsync","type":"`boolean`","description":"If true, the compensation function for this step is executed asynchronously. Which means, the response has to be set using `setStepSuccess` or `setStepFailure`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noCompensation","type":"`boolean`","description":"If true, no compensation action will be triggered for this step in case of a failure.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"continueOnPermanentFailure","type":"`boolean`","description":"Indicates whether the workflow should continue even if there is a permanent failure in this step.\nIn case it is set to true, the children steps of this step will not be executed and their status will be marked as `TransactionStepState`.SKIPPED\\_FAILURE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maxRetries","type":"`number`","description":"The maximum number of times this step should be retried in case of temporary failures.\nThe default is 0 (no retries).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noWait","type":"`boolean`","description":"If true, the workflow will not wait for their sibling steps to complete before moving to the next step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryInterval","type":"`number`","description":"The interval (in seconds) between retry attempts after a temporary failure.\nThe default is to retry immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryIntervalAwaiting","type":"`number`","description":"The interval (in seconds) to retry a step even if its status is `TransactionStepStatus.WAITING`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"If true, the response of this step will be stored.\nDefault is true.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"timeout","type":"`number`","description":"The maximum amount of time (in seconds) to wait for this step to complete.\nThis is NOT an execution timeout, the step will always be executed and wait for its response.\nIf the response is not received within the timeout set, it will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted as soon as it receives the response.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"compensate","type":"[WorkflowExecutionFn](../types.HttpTypes.WorkflowExecutionFn/page.mdx)","description":"The compensate function of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"state","type":"[TransactionStepState](../../types/types.HttpTypes.TransactionStepState/page.mdx)","description":"The state of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[TransactionStepStatus](../../types/types.HttpTypes.TransactionStepStatus/page.mdx)","description":"The status Line truncated
|
||||
<TypeList types={[{"name":"steps","type":"`Record<string, [AdminWorkflowExecutionStep](../types.HttpTypes.AdminWorkflowExecutionStep/page.mdx)>`","description":"The details of the workflow execution's steps.\nThe key is the step's ID, and the value is the step's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"[WorkflowExecutionFn](../types.HttpTypes.WorkflowExecutionFn/page.mdx)","description":"The invoke function of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"state","type":"[TransactionStepState](../../types/types.HttpTypes.TransactionStepState/page.mdx)","description":"The state of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[TransactionStepStatus](../../types/types.HttpTypes.TransactionStepStatus/page.mdx)","description":"The status of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"definition","type":"[WorkflowExecutionDefinition](../types.HttpTypes.WorkflowExecutionDefinition/page.mdx)","description":"The definition of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"async","type":"`boolean`","description":"If true, the step is executed asynchronously. This means that the workflow will not wait for the response of this step.\nAsync steps require to have their responses set using `setStepSuccess` or `setStepFailure`, unless it is combined with `backgroundExecution: true`.\nIf combined with a timeout, and any response is not set within that interval, the step will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateAsync","type":"`boolean`","description":"If true, the compensation function for this step is executed asynchronously. Which means, the response has to be set using `setStepSuccess` or `setStepFailure`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noCompensation","type":"`boolean`","description":"If true, no compensation action will be triggered for this step in case of a failure.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"continueOnPermanentFailure","type":"`boolean`","description":"Indicates whether the workflow should continue even if there is a permanent failure in this step.\nIn case it is set to true, the the current step will be marked as TransactionStepState.PERMANENT\\_FAILURE and the next steps will be executed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skipOnPermanentFailure","type":"`string` \\| `boolean`","description":"Indicates whether the workflow should skip all subsequent steps in case of a permanent failure in this step.\nIn case it is set to true, the next steps of the workflow will not be executed and their status will be marked as TransactionStepState.SKIPPED\\_FAILURE.\nIn case it is a string, the next steps until the step name provided will be skipped and the workflow will be resumed from the step provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maxRetries","type":"`number`","description":"The maximum number of times this step should be retried in case of temporary failures.\nThe default is 0 (no retries).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noWait","type":"`boolean`","description":"If true, the workflow will not wait for their sibling steps to complete before moving to the next step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryInterval","type":"`number`","description":"The interval (in seconds) between retry attempts after a temporary failure.\nThe default is to retry immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryIntervalAwaiting","type":"`number`","description":"The interval (in seconds) to retry a step even if its status is `TransactionStepStatus.WAITING`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"If true, the response of this step will be stored.\nDefault is true.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"timeout","type":"`number`","description":"The maximum amount of time (in seconds) to wait for this step to complete.\nThis is NOT an execution timeout, the step will always be executed and wait for its response.\nIf the response is not received within the timeout set, it will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted as soon as it receives the response.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"compensate","type":"Line truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"[WorkflowExecutionFn](../types.HttpTypes.WorkflowExecutionFn/page.mdx)","description":"The invoke function of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"state","type":"[TransactionStepState](../../types/types.HttpTypes.TransactionStepState/page.mdx)","description":"The state of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[TransactionStepStatus](../../types/types.HttpTypes.TransactionStepStatus/page.mdx)","description":"The status of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"definition","type":"[WorkflowExecutionDefinition](../types.HttpTypes.WorkflowExecutionDefinition/page.mdx)","description":"The definition of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"async","type":"`boolean`","description":"If true, the step is executed asynchronously. This means that the workflow will not wait for the response of this step.\nAsync steps require to have their responses set using `setStepSuccess` or `setStepFailure`, unless it is combined with `backgroundExecution: true`.\nIf combined with a timeout, and any response is not set within that interval, the step will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateAsync","type":"`boolean`","description":"If true, the compensation function for this step is executed asynchronously. Which means, the response has to be set using `setStepSuccess` or `setStepFailure`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noCompensation","type":"`boolean`","description":"If true, no compensation action will be triggered for this step in case of a failure.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"continueOnPermanentFailure","type":"`boolean`","description":"Indicates whether the workflow should continue even if there is a permanent failure in this step.\nIn case it is set to true, the children steps of this step will not be executed and their status will be marked as `TransactionStepState`.SKIPPED\\_FAILURE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maxRetries","type":"`number`","description":"The maximum number of times this step should be retried in case of temporary failures.\nThe default is 0 (no retries).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noWait","type":"`boolean`","description":"If true, the workflow will not wait for their sibling steps to complete before moving to the next step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryInterval","type":"`number`","description":"The interval (in seconds) between retry attempts after a temporary failure.\nThe default is to retry immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryIntervalAwaiting","type":"`number`","description":"The interval (in seconds) to retry a step even if its status is `TransactionStepStatus.WAITING`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"If true, the response of this step will be stored.\nDefault is true.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"timeout","type":"`number`","description":"The maximum amount of time (in seconds) to wait for this step to complete.\nThis is NOT an execution timeout, the step will always be executed and wait for its response.\nIf the response is not received within the timeout set, it will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted as soon as it receives the response.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"compensate","type":"[WorkflowExecutionFn](../types.HttpTypes.WorkflowExecutionFn/page.mdx)","description":"The compensate function of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"state","type":"[TransactionStepState](../../types/types.HttpTypes.TransactionStepState/page.mdx)","description":"The state of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[TransactionStepStatus](../../types/types.HttpTypes.TransactionStepStatus/page.mdx)","description":"The status of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"depth","type":"`number`","description":"The depth of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"startedAt","type":"`number`","description":"The date the step was started.","optionalLine truncated
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"[WorkflowExecutionFn](../types.HttpTypes.WorkflowExecutionFn/page.mdx)","description":"The invoke function of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"state","type":"[TransactionStepState](../../types/types.HttpTypes.TransactionStepState/page.mdx)","description":"The state of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[TransactionStepStatus](../../types/types.HttpTypes.TransactionStepStatus/page.mdx)","description":"The status of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"definition","type":"[WorkflowExecutionDefinition](../types.HttpTypes.WorkflowExecutionDefinition/page.mdx)","description":"The definition of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"async","type":"`boolean`","description":"If true, the step is executed asynchronously. This means that the workflow will not wait for the response of this step.\nAsync steps require to have their responses set using `setStepSuccess` or `setStepFailure`, unless it is combined with `backgroundExecution: true`.\nIf combined with a timeout, and any response is not set within that interval, the step will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateAsync","type":"`boolean`","description":"If true, the compensation function for this step is executed asynchronously. Which means, the response has to be set using `setStepSuccess` or `setStepFailure`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noCompensation","type":"`boolean`","description":"If true, no compensation action will be triggered for this step in case of a failure.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"continueOnPermanentFailure","type":"`boolean`","description":"Indicates whether the workflow should continue even if there is a permanent failure in this step.\nIn case it is set to true, the the current step will be marked as TransactionStepState.PERMANENT\\_FAILURE and the next steps will be executed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skipOnPermanentFailure","type":"`string` \\| `boolean`","description":"Indicates whether the workflow should skip all subsequent steps in case of a permanent failure in this step.\nIn case it is set to true, the next steps of the workflow will not be executed and their status will be marked as TransactionStepState.SKIPPED\\_FAILURE.\nIn case it is a string, the next steps until the step name provided will be skipped and the workflow will be resumed from the step provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maxRetries","type":"`number`","description":"The maximum number of times this step should be retried in case of temporary failures.\nThe default is 0 (no retries).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noWait","type":"`boolean`","description":"If true, the workflow will not wait for their sibling steps to complete before moving to the next step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryInterval","type":"`number`","description":"The interval (in seconds) between retry attempts after a temporary failure.\nThe default is to retry immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryIntervalAwaiting","type":"`number`","description":"The interval (in seconds) to retry a step even if its status is `TransactionStepStatus.WAITING`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"If true, the response of this step will be stored.\nDefault is true.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"timeout","type":"`number`","description":"The maximum amount of time (in seconds) to wait for this step to complete.\nThis is NOT an execution timeout, the step will always be executed and wait for its response.\nIf the response is not received within the timeout set, it will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted as soon as it receives the response.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"compensate","type":"[WorkflowExecutionFn](../types.HttpTypes.WorkflowExecutionFn/page.mdx)","description":"The compensate function of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"state","type":"[TransactionStepState](../../types/types.HttpTypes.TransactionStepState/page.mdx)","description":"The statLine truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"async","type":"`boolean`","description":"If true, the step is executed asynchronously. This means that the workflow will not wait for the response of this step.\nAsync steps require to have their responses set using `setStepSuccess` or `setStepFailure`, unless it is combined with `backgroundExecution: true`.\nIf combined with a timeout, and any response is not set within that interval, the step will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateAsync","type":"`boolean`","description":"If true, the compensation function for this step is executed asynchronously. Which means, the response has to be set using `setStepSuccess` or `setStepFailure`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noCompensation","type":"`boolean`","description":"If true, no compensation action will be triggered for this step in case of a failure.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"continueOnPermanentFailure","type":"`boolean`","description":"Indicates whether the workflow should continue even if there is a permanent failure in this step.\nIn case it is set to true, the children steps of this step will not be executed and their status will be marked as `TransactionStepState`.SKIPPED\\_FAILURE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maxRetries","type":"`number`","description":"The maximum number of times this step should be retried in case of temporary failures.\nThe default is 0 (no retries).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noWait","type":"`boolean`","description":"If true, the workflow will not wait for their sibling steps to complete before moving to the next step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryInterval","type":"`number`","description":"The interval (in seconds) between retry attempts after a temporary failure.\nThe default is to retry immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryIntervalAwaiting","type":"`number`","description":"The interval (in seconds) to retry a step even if its status is `TransactionStepStatus.WAITING`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"If true, the response of this step will be stored.\nDefault is true.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"timeout","type":"`number`","description":"The maximum amount of time (in seconds) to wait for this step to complete.\nThis is NOT an execution timeout, the step will always be executed and wait for its response.\nIf the response is not received within the timeout set, it will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted as soon as it receives the response.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="WorkflowExecutionDefinition"/>
|
||||
<TypeList types={[{"name":"async","type":"`boolean`","description":"If true, the step is executed asynchronously. This means that the workflow will not wait for the response of this step.\nAsync steps require to have their responses set using `setStepSuccess` or `setStepFailure`, unless it is combined with `backgroundExecution: true`.\nIf combined with a timeout, and any response is not set within that interval, the step will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateAsync","type":"`boolean`","description":"If true, the compensation function for this step is executed asynchronously. Which means, the response has to be set using `setStepSuccess` or `setStepFailure`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noCompensation","type":"`boolean`","description":"If true, no compensation action will be triggered for this step in case of a failure.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"continueOnPermanentFailure","type":"`boolean`","description":"Indicates whether the workflow should continue even if there is a permanent failure in this step.\nIn case it is set to true, the the current step will be marked as TransactionStepState.PERMANENT\\_FAILURE and the next steps will be executed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skipOnPermanentFailure","type":"`string` \\| `boolean`","description":"Indicates whether the workflow should skip all subsequent steps in case of a permanent failure in this step.\nIn case it is set to true, the next steps of the workflow will not be executed and their status will be marked as TransactionStepState.SKIPPED\\_FAILURE.\nIn case it is a string, the next steps until the step name provided will be skipped and the workflow will be resumed from the step provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maxRetries","type":"`number`","description":"The maximum number of times this step should be retried in case of temporary failures.\nThe default is 0 (no retries).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"noWait","type":"`boolean`","description":"If true, the workflow will not wait for their sibling steps to complete before moving to the next step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryInterval","type":"`number`","description":"The interval (in seconds) between retry attempts after a temporary failure.\nThe default is to retry immediately.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retryIntervalAwaiting","type":"`number`","description":"The interval (in seconds) to retry a step even if its status is `TransactionStepStatus.WAITING`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"If true, the response of this step will be stored.\nDefault is true.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"timeout","type":"`number`","description":"The maximum amount of time (in seconds) to wait for this step to complete.\nThis is NOT an execution timeout, the step will always be executed and wait for its response.\nIf the response is not received within the timeout set, it will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted as soon as it receives the response.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="WorkflowExecutionDefinition"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"output","type":"`object`","description":"The output details of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"output","type":"`unknown`","description":"The output of the step. This is the first parameter \npassed to the returned `StepResponse` function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateInput","type":"`unknown`","description":"The input of the step's compensation function.\nThis is the second parameter passed to the returned `StepResponse` function.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepInvokeResult"/>
|
||||
<TypeList types={[{"name":"output","type":"`object`","description":"The output details of the step.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"output","type":"`unknown`","description":"The output of the step. This is the first parameter\npassed to the returned `StepResponse` function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateInput","type":"`unknown`","description":"The input of the step's compensation function.\nThis is the second parameter passed to the returned `StepResponse` function.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepInvokeResult"/>
|
||||
@@ -28,7 +28,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"primaryKeyOrBulkData","type":"`string` \\| `string`[] \\| [`string` \\| `string`[], `string`, Record<string, unknown>?][]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKeyData","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"primaryKeyOrBulkData","type":"`string` \\| `string`[] \\| [`string` \\| `string`[], `string`, Record<string, unknown>?][]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKeyData","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraFields","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
@@ -16,6 +16,7 @@ import { TypeList } from "docs-ui"
|
||||
- [ProjectConfigOptions](../CommonTypes/interfaces/types.CommonTypes.ProjectConfigOptions/page.mdx)
|
||||
- [RepositoryTransformOptions](../CommonTypes/interfaces/types.CommonTypes.RepositoryTransformOptions/page.mdx)
|
||||
- [RequestQueryFields](../CommonTypes/interfaces/types.CommonTypes.RequestQueryFields/page.mdx)
|
||||
- [SessionOptions](../CommonTypes/interfaces/types.CommonTypes.SessionOptions/page.mdx)
|
||||
- [SoftDeletableEntity](../CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity/page.mdx)
|
||||
- [StringComparisonOperator](../CommonTypes/interfaces/types.CommonTypes.StringComparisonOperator/page.mdx)
|
||||
- [WithCalculatedPrice](../CommonTypes/interfaces/types.CommonTypes.WithCalculatedPrice/page.mdx)
|
||||
|
||||
@@ -7,11 +7,18 @@ import { TypeList } from "docs-ui"
|
||||
- [CreateFileDTO](../FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)
|
||||
- [FileDTO](../FileTypes/interfaces/types.FileTypes.FileDTO/page.mdx)
|
||||
- [FilterableFileProps](../FileTypes/interfaces/types.FileTypes.FilterableFileProps/page.mdx)
|
||||
- [GetUploadFileUrlDTO](../FileTypes/interfaces/types.FileTypes.GetUploadFileUrlDTO/page.mdx)
|
||||
- [IFileModuleService](../FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx)
|
||||
- [IFileProvider](../FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx)
|
||||
- [LocalFileServiceOptions](../FileTypes/interfaces/types.FileTypes.LocalFileServiceOptions/page.mdx)
|
||||
- [ProviderDeleteFileDTO](../FileTypes/interfaces/types.FileTypes.ProviderDeleteFileDTO/page.mdx)
|
||||
- [ProviderFileResultDTO](../FileTypes/interfaces/types.FileTypes.ProviderFileResultDTO/page.mdx)
|
||||
- [ProviderGetFileDTO](../FileTypes/interfaces/types.FileTypes.ProviderGetFileDTO/page.mdx)
|
||||
- [ProviderGetPresignedUploadUrlDTO](../FileTypes/interfaces/types.FileTypes.ProviderGetPresignedUploadUrlDTO/page.mdx)
|
||||
- [ProviderUploadFileDTO](../FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx)
|
||||
- [S3FileServiceOptions](../FileTypes/interfaces/types.FileTypes.S3FileServiceOptions/page.mdx)
|
||||
- [UploadFileUrlDTO](../FileTypes/interfaces/types.FileTypes.UploadFileUrlDTO/page.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [FileAccessPermission](../FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)
|
||||
+2
-1
@@ -18,10 +18,11 @@ The step's context.
|
||||
- [idempotencyKey](page.mdx#idempotencykey)
|
||||
- [metadata](page.mdx#metadata)
|
||||
- [parentStepIdempotencyKey](page.mdx#parentstepidempotencykey)
|
||||
- [preventReleaseEvents](page.mdx#preventreleaseevents)
|
||||
- [stepName](page.mdx#stepname)
|
||||
- [transactionId](page.mdx#transactionid)
|
||||
- [workflowId](page.mdx#workflowid)
|
||||
|
||||
___
|
||||
|
||||
<TypeList types={[{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"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":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","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":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepExecutionContext"/>
|
||||
<TypeList types={[{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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](../../../types/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":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"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":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"Whether to prevent release events.","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":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepExecutionContext"/>
|
||||
@@ -12,7 +12,7 @@ The type of compensation function passed to a step.
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"T \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"The step's context.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"input","type":"T \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"The step's context.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"Whether to prevent release events.","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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The type of invocation function passed to a step.
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"TInput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"The step's context.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"input","type":"TInput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"The step's context.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"Whether to prevent release events.","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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# StepFunction
|
||||
|
||||
**StepFunction**: KeysOfUnion<TInput> extends [] ? () => TOutput extends `Item`[] ? (`Item` \| [WorkflowData](../workflows.WorkflowData/page.mdx)<Item>)[] : TOutput extends `object` ? { [Key in string \| number \| symbol]: TOutput<(...)>[Key] \| WorkflowData<(...)[(...)]> } : TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & ``{ config: Method config }`` & [StepFunctionReturnConfig](../workflows.StepFunctionReturnConfig/page.mdx)<TOutput> : (`input`: TInput \| [WorkflowData](../workflows.WorkflowData/page.mdx)<TInput>) => TOutput extends `Item`[] ? (`Item` \| [WorkflowData](../workflows.WorkflowData/page.mdx)<Item>)[] : TOutput extends `object` ? { [Key in string \| number \| symbol]: TOutput<(...)>[Key] \| WorkflowData<(...)[(...)]> } : TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & ``{ config: Method config }`` & [StepFunctionReturnConfig](../workflows.StepFunctionReturnConfig/page.mdx)<TOutput> & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput>
|
||||
**StepFunction**: KeysOfUnion<TInput> extends [] ? () => TOutput & ``{}`` extends `never` ? ``{ $$type: "void" }`` & [Void](../workflows.Void/page.mdx) & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<[Void](../workflows.Void/page.mdx)> & ``{ config: Method config }`` & [StepFunctionReturnConfig](../workflows.StepFunctionReturnConfig/page.mdx)<TOutput> : TOutput extends `Item`[] ? (`Item` \| [WorkflowData](../workflows.WorkflowData/page.mdx)<Item>)[] : TOutput extends `object` ? { [Key in string \| number \| symbol]: (...)[(...)] \| WorkflowData<(...)> } : TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & ``{ config: Method config }`` & [StepFunctionReturnConfig](../workflows.StepFunctionReturnConfig/page.mdx)<TOutput> : (`input`: TInput \| [WorkflowData](../workflows.WorkflowData/page.mdx)<TInput>) => TOutput extends `Item`[] ? (`Item` \| [WorkflowData](../workflows.WorkflowData/page.mdx)<Item>)[] : TOutput extends `object` ? { [Key in string \| number \| symbol]: TOutput<(...)>[Key] \| WorkflowData<(...)[(...)]> } : TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & TOutput & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput> & ``{ config: Method config }`` & [StepFunctionReturnConfig](../workflows.StepFunctionReturnConfig/page.mdx)<TOutput> & [WorkflowDataProperties](../workflows.WorkflowDataProperties/page.mdx)<TOutput>
|
||||
|
||||
A step function to be used in a workflow.
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Void
|
||||
|
||||
**Void**: `Object`
|
||||
|
||||
<TypeList types={[{"name":" $$type","type":"`\"void\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Void"/>
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -18,7 +18,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 3,
|
||||
"character": 6,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L3"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L3"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -63,7 +63,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 5,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L5"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L5"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -107,7 +107,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 6,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L6"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L6"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -140,7 +140,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 7,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L7"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L7"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -173,7 +173,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 8,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L8"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L8"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -206,7 +206,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 9,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L9"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L9"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -239,7 +239,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 10,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L10"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L10"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -289,7 +289,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 11,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L11"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L11"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 12,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L12"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L12"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -357,7 +357,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 13,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L13"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L13"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -392,7 +392,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 14,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L14"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L14"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -429,7 +429,7 @@
|
||||
"fileName": "api-key.ts",
|
||||
"line": 4,
|
||||
"character": 20,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/api-key/src/models/api-key.ts#L4"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/api-key/src/models/api-key.ts#L4"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -30,7 +30,7 @@
|
||||
"fileName": "auth-identity.ts",
|
||||
"line": 4,
|
||||
"character": 13,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/auth-identity.ts#L4"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/auth-identity.ts#L4"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -75,7 +75,7 @@
|
||||
"fileName": "auth-identity.ts",
|
||||
"line": 6,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/auth-identity.ts#L6"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/auth-identity.ts#L6"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -122,7 +122,7 @@
|
||||
"fileName": "auth-identity.ts",
|
||||
"line": 7,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/auth-identity.ts#L7"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/auth-identity.ts#L7"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -164,7 +164,7 @@
|
||||
"fileName": "auth-identity.ts",
|
||||
"line": 10,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/auth-identity.ts#L10"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/auth-identity.ts#L10"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -194,7 +194,7 @@
|
||||
"fileName": "auth-identity.ts",
|
||||
"line": 5,
|
||||
"character": 27,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/auth-identity.ts#L5"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/auth-identity.ts#L5"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -226,7 +226,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 4,
|
||||
"character": 13,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L4"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L4"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -271,7 +271,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 6,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L6"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L6"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -315,7 +315,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 7,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L7"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L7"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -348,7 +348,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 8,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L8"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L8"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -384,7 +384,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 9,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L9"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L9"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -426,7 +426,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 12,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L12"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L12"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -461,7 +461,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 13,
|
||||
"character": 4,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L13"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L13"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -494,7 +494,7 @@
|
||||
"fileName": "provider-identity.ts",
|
||||
"line": 5,
|
||||
"character": 31,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/modules/auth/src/models/provider-identity.ts#L5"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/modules/auth/src/models/provider-identity.ts#L5"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": 40468,
|
||||
"id": 40663,
|
||||
"name": "auth-provider",
|
||||
"variant": "project",
|
||||
"kind": 1,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 40469,
|
||||
"id": 40664,
|
||||
"name": "AbstractAuthModuleProvider",
|
||||
"variant": "declaration",
|
||||
"kind": 128,
|
||||
@@ -27,7 +27,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 40470,
|
||||
"id": 40665,
|
||||
"name": "identifier",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -98,7 +98,7 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 68,
|
||||
"character": 9,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L68"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L68"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -107,7 +107,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40471,
|
||||
"id": 40666,
|
||||
"name": "DISPLAY_NAME",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -138,7 +138,7 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 79,
|
||||
"character": 9,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L79"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L79"
|
||||
}
|
||||
],
|
||||
"type": {
|
||||
@@ -147,7 +147,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40472,
|
||||
"id": 40667,
|
||||
"name": "validateOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -159,12 +159,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 129,
|
||||
"character": 9,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L129"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L129"
|
||||
}
|
||||
],
|
||||
"signatures": [
|
||||
{
|
||||
"id": 40473,
|
||||
"id": 40668,
|
||||
"name": "validateOptions",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -201,12 +201,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 129,
|
||||
"character": 9,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L129"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L129"
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"id": 40474,
|
||||
"id": 40669,
|
||||
"name": "options",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -248,21 +248,21 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 40475,
|
||||
"id": 40670,
|
||||
"name": "constructor",
|
||||
"variant": "declaration",
|
||||
"kind": 512,
|
||||
"flags": {},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 40476,
|
||||
"id": 40671,
|
||||
"name": "AbstractAuthModuleProvider",
|
||||
"variant": "signature",
|
||||
"kind": 16384,
|
||||
"flags": {},
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 40469,
|
||||
"target": 40664,
|
||||
"name": "AbstractAuthModuleProvider",
|
||||
"package": "@medusajs/utils"
|
||||
}
|
||||
@@ -270,7 +270,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 40484,
|
||||
"id": 40679,
|
||||
"name": "authenticate",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -282,12 +282,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 227,
|
||||
"character": 11,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L227"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L227"
|
||||
}
|
||||
],
|
||||
"signatures": [
|
||||
{
|
||||
"id": 40485,
|
||||
"id": 40680,
|
||||
"name": "authenticate",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -337,12 +337,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 227,
|
||||
"character": 11,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L227"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L227"
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"id": 40486,
|
||||
"id": 40681,
|
||||
"name": "data",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -366,7 +366,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40487,
|
||||
"id": 40682,
|
||||
"name": "authIdentityProviderService",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -440,7 +440,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40488,
|
||||
"id": 40683,
|
||||
"name": "register",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -450,12 +450,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 296,
|
||||
"character": 2,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L296"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L296"
|
||||
}
|
||||
],
|
||||
"signatures": [
|
||||
{
|
||||
"id": 40489,
|
||||
"id": 40684,
|
||||
"name": "register",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -501,12 +501,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 296,
|
||||
"character": 2,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L296"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L296"
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"id": 40490,
|
||||
"id": 40685,
|
||||
"name": "data",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -530,7 +530,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40491,
|
||||
"id": 40686,
|
||||
"name": "authIdentityProviderService",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -604,7 +604,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40492,
|
||||
"id": 40687,
|
||||
"name": "update",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -614,12 +614,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 348,
|
||||
"character": 2,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L348"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L348"
|
||||
}
|
||||
],
|
||||
"signatures": [
|
||||
{
|
||||
"id": 40493,
|
||||
"id": 40688,
|
||||
"name": "update",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -665,12 +665,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 348,
|
||||
"character": 2,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L348"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L348"
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"id": 40494,
|
||||
"id": 40689,
|
||||
"name": "data",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -728,7 +728,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40495,
|
||||
"id": 40690,
|
||||
"name": "authIdentityProviderService",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -802,7 +802,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40496,
|
||||
"id": 40691,
|
||||
"name": "validateCallback",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -812,12 +812,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 441,
|
||||
"character": 2,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L441"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L441"
|
||||
}
|
||||
],
|
||||
"signatures": [
|
||||
{
|
||||
"id": 40497,
|
||||
"id": 40692,
|
||||
"name": "validateCallback",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -832,7 +832,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "authenticate",
|
||||
"target": 40484
|
||||
"target": 40679
|
||||
},
|
||||
{
|
||||
"kind": "text",
|
||||
@@ -889,12 +889,12 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 441,
|
||||
"character": 2,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L441"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L441"
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"id": 40498,
|
||||
"id": 40693,
|
||||
"name": "data",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -918,7 +918,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 40499,
|
||||
"id": 40694,
|
||||
"name": "authIdentityProviderService",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -996,24 +996,24 @@
|
||||
{
|
||||
"title": "Constructors",
|
||||
"children": [
|
||||
40475
|
||||
40670
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
40470,
|
||||
40471
|
||||
40665,
|
||||
40666
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Methods",
|
||||
"children": [
|
||||
40472,
|
||||
40484,
|
||||
40488,
|
||||
40492,
|
||||
40496
|
||||
40667,
|
||||
40679,
|
||||
40683,
|
||||
40687,
|
||||
40691
|
||||
]
|
||||
}
|
||||
],
|
||||
@@ -1022,7 +1022,7 @@
|
||||
"fileName": "abstract-auth-provider.ts",
|
||||
"line": 56,
|
||||
"character": 22,
|
||||
"url": "https://github.com/medusajs/medusa/blob/e096af8b1b72b19e01f8d09cc50c7222d8459af1/packages/core/utils/src/auth/abstract-auth-provider.ts#L56"
|
||||
"url": "https://github.com/medusajs/medusa/blob/c53d25e44227bebb4ff4e66e9448d2066f0b7c10/packages/core/utils/src/auth/abstract-auth-provider.ts#L56"
|
||||
}
|
||||
],
|
||||
"implementedTypes": [
|
||||
@@ -1042,101 +1042,101 @@
|
||||
{
|
||||
"title": "Classes",
|
||||
"children": [
|
||||
40469
|
||||
40664
|
||||
]
|
||||
}
|
||||
],
|
||||
"packageName": "@medusajs/utils",
|
||||
"symbolIdMap": {
|
||||
"40468": {
|
||||
"40663": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": ""
|
||||
},
|
||||
"40469": {
|
||||
"40664": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider"
|
||||
},
|
||||
"40470": {
|
||||
"40665": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.identifier"
|
||||
},
|
||||
"40471": {
|
||||
"40666": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.DISPLAY_NAME"
|
||||
},
|
||||
"40472": {
|
||||
"40667": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.validateOptions"
|
||||
},
|
||||
"40473": {
|
||||
"40668": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.validateOptions"
|
||||
},
|
||||
"40474": {
|
||||
"40669": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "options"
|
||||
},
|
||||
"40484": {
|
||||
"40679": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.authenticate"
|
||||
},
|
||||
"40485": {
|
||||
"40680": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.authenticate"
|
||||
},
|
||||
"40486": {
|
||||
"40681": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "data"
|
||||
},
|
||||
"40487": {
|
||||
"40682": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "authIdentityProviderService"
|
||||
},
|
||||
"40488": {
|
||||
"40683": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.register"
|
||||
},
|
||||
"40489": {
|
||||
"40684": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.register"
|
||||
},
|
||||
"40490": {
|
||||
"40685": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "data"
|
||||
},
|
||||
"40491": {
|
||||
"40686": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "authIdentityProviderService"
|
||||
},
|
||||
"40492": {
|
||||
"40687": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.update"
|
||||
},
|
||||
"40493": {
|
||||
"40688": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.update"
|
||||
},
|
||||
"40494": {
|
||||
"40689": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "data"
|
||||
},
|
||||
"40495": {
|
||||
"40690": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "authIdentityProviderService"
|
||||
},
|
||||
"40496": {
|
||||
"40691": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.validateCallback"
|
||||
},
|
||||
"40497": {
|
||||
"40692": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "AbstractAuthModuleProvider.validateCallback"
|
||||
},
|
||||
"40498": {
|
||||
"40693": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "data"
|
||||
},
|
||||
"40499": {
|
||||
"40694": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
|
||||
"qualifiedName": "authIdentityProviderService"
|
||||
}
|
||||
@@ -1146,7 +1146,7 @@
|
||||
"1": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts"
|
||||
},
|
||||
"reflections": {
|
||||
"1": 40468
|
||||
"1": 40663
|
||||
}
|
||||
}
|
||||
}
|
||||
Loaded 100 of 149 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user