From f521260a8fca12c34d61eaaca9d7d1a3e1d63639 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 11 Jan 2023 18:08:25 +0200 Subject: [PATCH 01/14] chore(docs): Generated Services Reference (automated) (#2993) Co-authored-by: olivermrbl --- .../classes/AnalyticsConfigService.md | 28 +- .../services/classes/AuthService.md | 28 +- .../services/classes/BatchJobService.md | 50 +- .../services/classes/CacheService.md | 10 +- .../services/classes/CartService.md | 184 +++--- .../services/classes/ClaimItemService.md | 36 +- .../services/classes/ClaimService.md | 86 +-- .../services/classes/CurrencyService.md | 30 +- .../classes/CustomShippingOptionService.md | 24 +- .../services/classes/CustomerGroupService.md | 38 +- .../services/classes/CustomerService.md | 62 +- .../classes/DiscountConditionService.md | 30 +- .../services/classes/DiscountService.md | 82 +-- .../services/classes/DraftOrderService.md | 52 +- .../services/classes/EventBusService.md | 78 ++- .../classes/FulfillmentProviderService.md | 44 +- .../services/classes/FulfillmentService.md | 58 +- .../services/classes/GiftCardService.md | 48 +- .../services/classes/IdempotencyKeyService.md | 30 +- .../services/classes/InventoryService.md | 232 -------- .../classes/LineItemAdjustmentService.md | 36 +- .../services/classes/LineItemService.md | 72 +-- .../services/classes/MiddlewareService.md | 28 +- .../services/classes/NewTotalsService.md | 42 +- .../services/classes/NoteService.md | 32 +- .../services/classes/NotificationService.md | 46 +- .../services/classes/OauthService.md | 42 +- .../classes/OrderEditItemChangeService.md | 34 +- .../services/classes/OrderEditService.md | 74 +-- .../services/classes/OrderService.md | 133 ++--- .../classes/PaymentCollectionService.md | 50 +- .../classes/PaymentProviderService.md | 83 +-- .../services/classes/PaymentService.md | 34 +- .../services/classes/PriceListService.md | 62 +- .../services/classes/PricingService.md | 52 +- .../classes/ProductCategoryService.md | 283 ++++++++++ .../classes/ProductCollectionService.md | 40 +- .../services/classes/ProductService.md | 82 +-- .../services/classes/ProductTypeService.md | 24 +- .../classes/ProductVariantInventoryService.md | 529 ++++++++++++++++++ .../services/classes/ProductVariantService.md | 66 +-- .../services/classes/RegionService.md | 74 +-- .../services/classes/ReturnReasonService.md | 28 +- .../services/classes/ReturnService.md | 92 +-- .../classes/SalesChannelInventoryService.md | 82 +++ .../classes/SalesChannelLocationService.md | 276 +++++++++ .../services/classes/SalesChannelService.md | 44 +- .../services/classes/SearchService.md | 40 +- .../services/classes/ShippingOptionService.md | 60 +- .../classes/ShippingProfileService.md | 54 +- .../services/classes/StoreService.md | 34 +- .../classes/StrategyResolverService.md | 20 +- .../services/classes/SwapService.md | 92 +-- .../classes/SystemPaymentProviderService.md | 38 +- .../services/classes/TaxProviderService.md | 56 +- .../services/classes/TaxRateService.md | 52 +- .../services/classes/TokenService.md | 10 +- .../services/classes/TotalsService.md | 70 +-- .../services/classes/UserService.md | 46 +- docs/content/references/services/index.md | 5 +- 60 files changed, 2600 insertions(+), 1647 deletions(-) delete mode 100644 docs/content/references/services/classes/InventoryService.md create mode 100644 docs/content/references/services/classes/ProductCategoryService.md create mode 100644 docs/content/references/services/classes/ProductVariantInventoryService.md create mode 100644 docs/content/references/services/classes/SalesChannelInventoryService.md create mode 100644 docs/content/references/services/classes/SalesChannelLocationService.md diff --git a/docs/content/references/services/classes/AnalyticsConfigService.md b/docs/content/references/services/classes/AnalyticsConfigService.md index e076237e40..02ff929140 100644 --- a/docs/content/references/services/classes/AnalyticsConfigService.md +++ b/docs/content/references/services/classes/AnalyticsConfigService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L24) +[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L24) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L21) +[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L21) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L18) +[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L18) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L19) +[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L19) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L22) +[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L22) ## Methods @@ -139,7 +139,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -162,7 +162,7 @@ Creates an analytics config. #### Defined in -[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L56) +[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L56) ___ @@ -184,7 +184,7 @@ Deletes an analytics config. #### Defined in -[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L103) +[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L103) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L32) +[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L32) ___ @@ -228,7 +228,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -251,7 +251,7 @@ Updates an analytics config. If the config does not exist, it will be created in #### Defined in -[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L72) +[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/analytics-config.ts#L72) ___ @@ -275,4 +275,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/AuthService.md b/docs/content/references/services/classes/AuthService.md index 637d34859b..e11067a682 100644 --- a/docs/content/references/services/classes/AuthService.md +++ b/docs/content/references/services/classes/AuthService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L24) +[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L24) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L22) +[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L22) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L19) +[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L19) ___ @@ -92,7 +92,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L20) +[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L20) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L21) +[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L21) ## Methods @@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -169,7 +169,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L97) +[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L97) ___ @@ -195,7 +195,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L54) +[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L54) ___ @@ -223,7 +223,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L146) +[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L146) ___ @@ -248,7 +248,7 @@ the result of the comparison #### Defined in -[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L38) +[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/auth.ts#L38) ___ @@ -272,7 +272,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -296,4 +296,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/BatchJobService.md b/docs/content/references/services/classes/BatchJobService.md index ba05e118b2..3800d99c38 100644 --- a/docs/content/references/services/classes/BatchJobService.md +++ b/docs/content/references/services/classes/BatchJobService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L93) +[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L93) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L41) +[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L41) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L45) +[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L45) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L42) +[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L42) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L38) +[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L38) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L43) +[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L43) ___ @@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L39) +[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L39) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L27) +[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L27) ## Methods @@ -182,7 +182,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L277) +[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L277) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L259) +[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L259) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L241) +[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L241) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L146) +[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L146) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L135) +[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L135) ___ @@ -304,7 +304,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L374) +[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L374) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L108) +[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L108) ___ @@ -346,7 +346,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L348) +[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L348) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L295) +[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L295) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L328) +[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L328) ___ @@ -410,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L165) +[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L165) ___ @@ -452,7 +452,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L206) +[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/batch-job.ts#L206) ___ @@ -476,4 +476,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CacheService.md b/docs/content/references/services/classes/CacheService.md index b5a62ec82c..27e69bc7a9 100644 --- a/docs/content/references/services/classes/CacheService.md +++ b/docs/content/references/services/classes/CacheService.md @@ -18,7 +18,7 @@ #### Defined in -[packages/medusa/src/services/cache.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L10) +[packages/medusa/src/services/cache.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cache.ts#L10) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[packages/medusa/src/services/cache.ts:8](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L8) +[packages/medusa/src/services/cache.ts:8](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cache.ts#L8) ## Methods @@ -60,7 +60,7 @@ ICacheService.get #### Defined in -[packages/medusa/src/services/cache.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L40) +[packages/medusa/src/services/cache.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cache.ts#L40) ___ @@ -86,7 +86,7 @@ ICacheService.invalidate #### Defined in -[packages/medusa/src/services/cache.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L56) +[packages/medusa/src/services/cache.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cache.ts#L56) ___ @@ -116,4 +116,4 @@ ICacheService.set #### Defined in -[packages/medusa/src/services/cache.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L22) +[packages/medusa/src/services/cache.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cache.ts#L22) diff --git a/docs/content/references/services/classes/CartService.md b/docs/content/references/services/classes/CartService.md index f20613cc38..583520d0ea 100644 --- a/docs/content/references/services/classes/CartService.md +++ b/docs/content/references/services/classes/CartService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L131) +[packages/medusa/src/services/cart.ts:136](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L136) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L107) +[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L111) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L106) +[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L110) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L126) +[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L129) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L118) +[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L122) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L120) +[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L124) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L110) +[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L114) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L129) +[packages/medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L132) ___ @@ -132,17 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L121) - -___ - -### inventoryService\_ - -• `Protected` `Readonly` **inventoryService\_**: [`InventoryService`](InventoryService.md) - -#### Defined in - -[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L125) +[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L125) ___ @@ -152,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L128) +[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L131) ___ @@ -162,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L109) +[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L113) ___ @@ -172,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L116) +[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L120) ___ @@ -186,7 +176,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L102) +[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L106) ___ @@ -196,7 +186,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L124) +[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L128) ___ @@ -206,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L117) +[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L121) ___ @@ -216,7 +206,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L108) +[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L112) ___ @@ -226,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L127) +[packages/medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L130) ___ @@ -236,7 +226,17 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L112) +[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L116) + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Defined in + +[packages/medusa/src/services/cart.ts:134](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L134) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L111) +[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L115) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L115) +[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L119) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L114) +[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L118) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L105) +[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L109) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L119) +[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L123) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L113) +[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L117) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L122) +[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L126) ___ @@ -316,7 +316,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L123) +[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L127) ___ @@ -330,7 +330,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L103) +[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L107) ___ @@ -348,7 +348,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L96) +[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L100) ## Methods @@ -379,7 +379,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:613](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L613) +[packages/medusa/src/services/cart.ts:618](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L618) ___ @@ -407,7 +407,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:719](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L719) +[packages/medusa/src/services/cart.ts:744](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L744) ___ @@ -437,7 +437,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1862](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1862) +[packages/medusa/src/services/cart.ts:2041](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2041) ___ @@ -465,7 +465,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:934](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L934) +[packages/medusa/src/services/cart.ts:991](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L991) ___ @@ -493,7 +493,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1358](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1358) +[packages/medusa/src/services/cart.ts:1415](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1415) ___ @@ -514,7 +514,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1322](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1322) +[packages/medusa/src/services/cart.ts:1379](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1379) ___ @@ -553,7 +553,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -582,7 +582,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1508](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1508) +[packages/medusa/src/services/cart.ts:1565](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1565) ___ @@ -606,7 +606,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/cart.ts:314](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L314) +[packages/medusa/src/services/cart.ts:319](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L319) ___ @@ -630,7 +630,7 @@ the resultign customer object #### Defined in -[packages/medusa/src/services/cart.ts:1209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1209) +[packages/medusa/src/services/cart.ts:1266](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1266) ___ @@ -650,7 +650,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2269](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2269) +[packages/medusa/src/services/cart.ts:2451](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2451) ___ @@ -671,7 +671,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2319](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2319) +[packages/medusa/src/services/cart.ts:2501](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2501) ___ @@ -697,7 +697,7 @@ Use decorateTotals instead #### Defined in -[packages/medusa/src/services/cart.ts:2491](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2491) +[packages/medusa/src/services/cart.ts:2673](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2673) ___ @@ -721,13 +721,13 @@ the deleted cart or undefined if the cart was not found. #### Defined in -[packages/medusa/src/services/cart.ts:2184](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2184) +[packages/medusa/src/services/cart.ts:2366](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2366) ___ ### deletePaymentSession -▸ **deletePaymentSession**(`cartId`, `providerId`): `Promise`<`Cart`\> +▸ **deletePaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> Removes a payment session from the cart. @@ -740,13 +740,13 @@ Removes a payment session from the cart. #### Returns -`Promise`<`Cart`\> +`Promise`<`void`\> the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:1764](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1764) +[packages/medusa/src/services/cart.ts:1932](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1932) ___ @@ -766,7 +766,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2300](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2300) +[packages/medusa/src/services/cart.ts:2482](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2482) ___ @@ -792,7 +792,7 @@ custom shipping option #### Defined in -[packages/medusa/src/services/cart.ts:1970](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1970) +[packages/medusa/src/services/cart.ts:2149](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2149) ___ @@ -812,7 +812,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2542](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2542) +[packages/medusa/src/services/cart.ts:2724](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2724) ___ @@ -832,7 +832,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:450](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L450) +[packages/medusa/src/services/cart.ts:455](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L455) ___ @@ -855,7 +855,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/cart.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L195) +[packages/medusa/src/services/cart.ts:200](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L200) ___ @@ -880,7 +880,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:1155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1155) +[packages/medusa/src/services/cart.ts:1212](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1212) ___ @@ -900,13 +900,13 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2413](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2413) +[packages/medusa/src/services/cart.ts:2595](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2595) ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`Cart`\> +▸ **refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> Refreshes a payment session on a cart @@ -919,13 +919,13 @@ Refreshes a payment session on a cart #### Returns -`Promise`<`Cart`\> +`Promise`<`void`\> the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:1812](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1812) +[packages/medusa/src/services/cart.ts:1986](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1986) ___ @@ -950,7 +950,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1418](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1418) +[packages/medusa/src/services/cart.ts:1475](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1475) ___ @@ -975,7 +975,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:482](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L482) +[packages/medusa/src/services/cart.ts:487](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L487) ___ @@ -1001,7 +1001,7 @@ the cart document. #### Defined in -[packages/medusa/src/services/cart.ts:213](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L213) +[packages/medusa/src/services/cart.ts:218](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L218) ___ @@ -1025,7 +1025,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:262](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L262) +[packages/medusa/src/services/cart.ts:267](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L267) ___ @@ -1047,7 +1047,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:294](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L294) +[packages/medusa/src/services/cart.ts:299](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L299) ___ @@ -1075,15 +1075,15 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/cart.ts:2227](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2227) +[packages/medusa/src/services/cart.ts:2409](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2409) ___ ### setPaymentSession -▸ **setPaymentSession**(`cartId`, `providerId`): `Promise`<`Cart`\> +▸ **setPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> -Sets a payment method for a cart. +Selects a payment session for a cart and creates a payment object in the external provider system #### Parameters @@ -1094,13 +1094,11 @@ Sets a payment method for a cart. #### Returns -`Promise`<`Cart`\> - -result of update operation +`Promise`<`void`\> #### Defined in -[packages/medusa/src/services/cart.ts:1583](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1583) +[packages/medusa/src/services/cart.ts:1639](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1639) ___ @@ -1128,7 +1126,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/cart.ts:1649](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1649) +[packages/medusa/src/services/cart.ts:1754](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1754) ___ @@ -1154,7 +1152,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:2050](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2050) +[packages/medusa/src/services/cart.ts:2232](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2232) ___ @@ -1178,7 +1176,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -1198,7 +1196,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2433](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2433) +[packages/medusa/src/services/cart.ts:2615](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2615) ___ @@ -1219,7 +1217,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:977](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L977) +[packages/medusa/src/services/cart.ts:1034](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1034) ___ @@ -1245,7 +1243,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1235](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1235) +[packages/medusa/src/services/cart.ts:1292](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1292) ___ @@ -1270,7 +1268,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1191](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1191) +[packages/medusa/src/services/cart.ts:1248](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1248) ___ @@ -1296,7 +1294,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:869](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L869) +[packages/medusa/src/services/cart.ts:914](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L914) ___ @@ -1321,7 +1319,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1470](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1470) +[packages/medusa/src/services/cart.ts:1527](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1527) ___ @@ -1347,7 +1345,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1273](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1273) +[packages/medusa/src/services/cart.ts:1330](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L1330) ___ @@ -1369,7 +1367,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1989](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1989) +[packages/medusa/src/services/cart.ts:2168](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L2168) ___ @@ -1395,7 +1393,7 @@ a boolean indicating validation result #### Defined in -[packages/medusa/src/services/cart.ts:579](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L579) +[packages/medusa/src/services/cart.ts:584](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L584) ___ @@ -1422,7 +1420,7 @@ boolean representing whether shipping method is validated #### Defined in -[packages/medusa/src/services/cart.ts:548](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L548) +[packages/medusa/src/services/cart.ts:553](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/cart.ts#L553) ___ @@ -1446,4 +1444,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ClaimItemService.md b/docs/content/references/services/classes/ClaimItemService.md index 6662d5e191..d6ebd03fae 100644 --- a/docs/content/references/services/classes/ClaimItemService.md +++ b/docs/content/references/services/classes/ClaimItemService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L30) +[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L30) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L25) +[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L25) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L23) +[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L23) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L24) +[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L24) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L22) +[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L22) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L21) +[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L21) ___ @@ -116,7 +116,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L27) +[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L27) ___ @@ -130,7 +130,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L28) +[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L28) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L15) +[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L15) ## Methods @@ -187,7 +187,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -207,7 +207,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L49) +[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L49) ___ @@ -230,7 +230,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L214) +[packages/medusa/src/services/claim-item.ts:221](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L221) ___ @@ -255,7 +255,7 @@ the ClaimItem #### Defined in -[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L233) +[packages/medusa/src/services/claim-item.ts:240](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L240) ___ @@ -279,7 +279,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L132) +[packages/medusa/src/services/claim-item.ts:139](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim-item.ts#L139) ___ @@ -324,4 +324,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ClaimService.md b/docs/content/references/services/classes/ClaimService.md index fe9e58042f..c78f7a3559 100644 --- a/docs/content/references/services/classes/ClaimService.md +++ b/docs/content/references/services/classes/ClaimService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L83) +[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L84) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L66) +[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L66) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L70) +[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L70) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L67) +[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L67) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L71) +[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L71) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L72) +[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L72) ___ @@ -112,17 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L73) - -___ - -### inventoryService\_ - -• `Protected` `Readonly` **inventoryService\_**: [`InventoryService`](InventoryService.md) - -#### Defined in - -[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L74) +[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L73) ___ @@ -132,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L69) +[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L69) ___ @@ -142,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L75) +[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L74) ___ @@ -156,7 +146,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L63) +[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L63) ___ @@ -166,7 +156,17 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L76) +[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L75) + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Defined in + +[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L82) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L77) +[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L76) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L78) +[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L77) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L68) +[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L68) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L79) +[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L78) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L80) +[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L79) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L81) +[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L80) ___ @@ -240,7 +240,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L64) +[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L64) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L54) +[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L54) ## Methods @@ -300,7 +300,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L761) +[packages/medusa/src/services/claim.ts:760](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L760) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:609](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L609) +[packages/medusa/src/services/claim.ts:608](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L608) ___ @@ -366,7 +366,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:213](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L213) +[packages/medusa/src/services/claim.ts:214](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L214) ___ @@ -391,7 +391,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:463](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L463) +[packages/medusa/src/services/claim.ts:462](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L462) ___ @@ -416,7 +416,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:681](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L681) +[packages/medusa/src/services/claim.ts:680](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L680) ___ @@ -439,7 +439,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim.ts:817](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L817) +[packages/medusa/src/services/claim.ts:816](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L816) ___ @@ -459,7 +459,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L635) +[packages/medusa/src/services/claim.ts:634](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L634) ___ @@ -484,7 +484,7 @@ the order document #### Defined in -[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L837) +[packages/medusa/src/services/claim.ts:836](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L836) ___ @@ -508,7 +508,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -529,7 +529,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L125) +[packages/medusa/src/services/claim.ts:126](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/claim.ts#L126) ___ @@ -553,4 +553,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CurrencyService.md b/docs/content/references/services/classes/CurrencyService.md index 8a954acd1a..e9ea2f3200 100644 --- a/docs/content/references/services/classes/CurrencyService.md +++ b/docs/content/references/services/classes/CurrencyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L32) +[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L32) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L28) +[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L28) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L29) +[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L29) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L30) +[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L30) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L25) +[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L25) ___ @@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L26) +[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L26) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L21) +[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L21) ## Methods @@ -165,7 +165,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -193,7 +193,7 @@ an array containing the currencies as #### Defined in -[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L81) +[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L81) ___ @@ -217,7 +217,7 @@ The currency #### Defined in -[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L50) +[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L50) ___ @@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -266,7 +266,7 @@ The updated currency #### Defined in -[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L103) +[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/currency.ts#L103) ___ @@ -290,4 +290,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CustomShippingOptionService.md b/docs/content/references/services/classes/CustomShippingOptionService.md index f2c7cf3100..66c6f1a62e 100644 --- a/docs/content/references/services/classes/CustomShippingOptionService.md +++ b/docs/content/references/services/classes/CustomShippingOptionService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/custom-shipping-option.ts#L20) +[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/custom-shipping-option.ts#L20) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/custom-shipping-option.ts#L18) +[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/custom-shipping-option.ts#L18) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/custom-shipping-option.ts#L15) +[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/custom-shipping-option.ts#L15) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/custom-shipping-option.ts#L16) +[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/custom-shipping-option.ts#L16) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -153,7 +153,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/custom-shipping-option.ts#L89) +[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/custom-shipping-option.ts#L89) ___ @@ -178,7 +178,7 @@ custom shipping options matching the query #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/custom-shipping-option.ts#L65) +[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/custom-shipping-option.ts#L65) ___ @@ -203,7 +203,7 @@ the requested custom shipping option. #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/custom-shipping-option.ts#L37) +[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/custom-shipping-option.ts#L37) ___ @@ -227,7 +227,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -251,4 +251,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CustomerGroupService.md b/docs/content/references/services/classes/CustomerGroupService.md index e6f65bb8f2..dad086459b 100644 --- a/docs/content/references/services/classes/CustomerGroupService.md +++ b/docs/content/references/services/classes/CustomerGroupService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L27) +[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L27) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L24) +[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L24) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L25) +[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L25) ___ @@ -86,7 +86,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L21) +[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L21) ___ @@ -100,7 +100,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L22) +[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L22) ## Methods @@ -125,7 +125,7 @@ the customer group after insertion #### Defined in -[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L94) +[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L94) ___ @@ -164,7 +164,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -196,7 +196,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L70) +[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L70) ___ @@ -220,7 +220,7 @@ a promise #### Defined in -[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L158) +[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L158) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L261) +[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L261) ___ @@ -267,7 +267,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L181) +[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L181) ___ @@ -292,7 +292,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L199) +[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L199) ___ @@ -317,7 +317,7 @@ the customergroup with the provided id #### Defined in -[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L240) +[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L240) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L40) +[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L40) ___ @@ -362,7 +362,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -387,7 +387,7 @@ resulting customer group #### Defined in -[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L125) +[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer-group.ts#L125) ___ @@ -411,4 +411,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CustomerService.md b/docs/content/references/services/classes/CustomerService.md index 5a7e57bc94..96f3b4de6c 100644 --- a/docs/content/references/services/classes/CustomerService.md +++ b/docs/content/references/services/classes/CustomerService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L39) +[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L39) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L27) +[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L27) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L26) +[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L26) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L28) +[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L28) ___ @@ -98,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L30) +[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L30) ___ @@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L31) +[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L31) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L33) +[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L33) ## Methods @@ -151,7 +151,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L498) +[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L498) ___ @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -208,7 +208,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L158) +[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L158) ___ @@ -235,7 +235,7 @@ the result of create #### Defined in -[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L285) +[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L285) ___ @@ -259,7 +259,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L546) +[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L546) ___ @@ -287,7 +287,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L64) +[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L64) ___ @@ -311,7 +311,7 @@ hashed password #### Defined in -[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L272) +[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L272) ___ @@ -334,7 +334,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L107) +[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L107) ___ @@ -357,7 +357,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L131) +[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L131) ___ @@ -378,7 +378,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L228) +[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L228) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L481) +[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L481) ___ @@ -424,7 +424,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L253) +[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L253) ___ @@ -451,7 +451,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L195) +[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L195) ___ @@ -476,7 +476,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L240) +[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L240) ___ @@ -497,7 +497,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L218) +[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L218) ___ @@ -518,7 +518,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L209) +[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L209) ___ @@ -539,7 +539,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L164) +[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L164) ___ @@ -563,7 +563,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -588,7 +588,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L341) +[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L341) ___ @@ -610,7 +610,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L453) +[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L453) ___ @@ -635,7 +635,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L401) +[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/customer.ts#L401) ___ @@ -659,4 +659,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/DiscountConditionService.md b/docs/content/references/services/classes/DiscountConditionService.md index c4649c39f3..65155ec3ba 100644 --- a/docs/content/references/services/classes/DiscountConditionService.md +++ b/docs/content/references/services/classes/DiscountConditionService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L37) +[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L37) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L31) +[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L31) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L32) +[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L32) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L34) +[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L34) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L35) +[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L35) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L220) +[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L220) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L188) +[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L188) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L49) +[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L49) ___ @@ -228,7 +228,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -249,7 +249,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L116) +[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L116) ___ @@ -273,7 +273,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) ___ @@ -293,4 +293,4 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L79) +[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount-condition.ts#L79) diff --git a/docs/content/references/services/classes/DiscountService.md b/docs/content/references/services/classes/DiscountService.md index 699c4ed1b8..1b371e9937 100644 --- a/docs/content/references/services/classes/DiscountService.md +++ b/docs/content/references/services/classes/DiscountService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L68) +[packages/medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L68) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L55) +[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L55) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L59) +[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L59) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L60) +[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L60) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L54) +[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L54) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L56) +[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L56) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L65) +[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L65) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L66) +[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L66) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L57) +[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L57) ___ @@ -150,7 +150,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L51) +[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L51) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L62) +[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L62) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L63) +[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L63) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L64) +[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L64) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L61) +[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L61) ___ @@ -204,7 +204,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L52) +[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L52) ## Methods @@ -229,7 +229,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L487) +[packages/medusa/src/services/discount.ts:487](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L487) ___ @@ -268,7 +268,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -290,7 +290,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:588](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L588) +[packages/medusa/src/services/discount.ts:588](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L588) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L762) +[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L762) ___ @@ -336,7 +336,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:186](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L186) +[packages/medusa/src/services/discount.ts:186](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L186) ___ @@ -361,7 +361,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:415](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L415) +[packages/medusa/src/services/discount.ts:415](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L415) ___ @@ -385,7 +385,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/discount.ts:547](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L547) +[packages/medusa/src/services/discount.ts:547](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L547) ___ @@ -410,7 +410,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:466](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L466) +[packages/medusa/src/services/discount.ts:466](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L466) ___ @@ -430,7 +430,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:731](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L731) +[packages/medusa/src/services/discount.ts:731](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L731) ___ @@ -450,7 +450,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:727](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L727) +[packages/medusa/src/services/discount.ts:727](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L727) ___ @@ -470,7 +470,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:721](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L721) +[packages/medusa/src/services/discount.ts:721](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L721) ___ @@ -490,7 +490,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:739](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L739) +[packages/medusa/src/services/discount.ts:739](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L739) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:743](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L743) +[packages/medusa/src/services/discount.ts:743](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L743) ___ @@ -534,7 +534,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:124](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L124) +[packages/medusa/src/services/discount.ts:124](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L124) ___ @@ -557,7 +557,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:140](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L140) +[packages/medusa/src/services/discount.ts:140](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L140) ___ @@ -582,7 +582,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:522](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L522) +[packages/medusa/src/services/discount.ts:522](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L522) ___ @@ -607,7 +607,7 @@ the discount #### Defined in -[packages/medusa/src/services/discount.ts:252](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L252) +[packages/medusa/src/services/discount.ts:252](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L252) ___ @@ -632,7 +632,7 @@ the discount document #### Defined in -[packages/medusa/src/services/discount.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L285) +[packages/medusa/src/services/discount.ts:285](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L285) ___ @@ -656,7 +656,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -681,7 +681,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:318](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L318) +[packages/medusa/src/services/discount.ts:318](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L318) ___ @@ -702,7 +702,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:661](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L661) +[packages/medusa/src/services/discount.ts:661](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L661) ___ @@ -723,7 +723,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:561](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L561) +[packages/medusa/src/services/discount.ts:561](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L561) ___ @@ -753,7 +753,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L106) +[packages/medusa/src/services/discount.ts:106](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L106) ___ @@ -777,4 +777,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/DraftOrderService.md b/docs/content/references/services/classes/DraftOrderService.md index 4066259b3a..e72ae7577b 100644 --- a/docs/content/references/services/classes/DraftOrderService.md +++ b/docs/content/references/services/classes/DraftOrderService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L54) +[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L54) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L48) +[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L48) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L52) +[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L52) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L44) +[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L44) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L47) +[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L47) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L49) +[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L49) ___ @@ -120,7 +120,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L41) +[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L41) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L46) +[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L46) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L45) +[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L45) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L50) +[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L50) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L51) +[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L51) ___ @@ -174,7 +174,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L42) +[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L42) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L36) +[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L36) ## Methods @@ -230,7 +230,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -254,7 +254,7 @@ the created draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:248](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L248) +[packages/medusa/src/services/draft-order.ts:248](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L248) ___ @@ -278,7 +278,7 @@ empty promise #### Defined in -[packages/medusa/src/services/draft-order.ts:147](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L147) +[packages/medusa/src/services/draft-order.ts:147](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L147) ___ @@ -303,7 +303,7 @@ list of draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:225](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L225) +[packages/medusa/src/services/draft-order.ts:225](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L225) ___ @@ -328,7 +328,7 @@ draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:171](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L171) +[packages/medusa/src/services/draft-order.ts:171](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L171) ___ @@ -353,7 +353,7 @@ the created order #### Defined in -[packages/medusa/src/services/draft-order.ts:372](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L372) +[packages/medusa/src/services/draft-order.ts:372](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L372) ___ @@ -378,7 +378,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L87) +[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L87) ___ @@ -403,7 +403,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L121) +[packages/medusa/src/services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L121) ___ @@ -427,7 +427,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -453,7 +453,7 @@ the updated draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:401](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L401) +[packages/medusa/src/services/draft-order.ts:401](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/draft-order.ts#L401) ___ @@ -477,4 +477,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/EventBusService.md b/docs/content/references/services/classes/EventBusService.md index 964dfe3e6a..16a6c4abad 100644 --- a/docs/content/references/services/classes/EventBusService.md +++ b/docs/content/references/services/classes/EventBusService.md @@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L48) +[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L73) ## Properties @@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L35) +[packages/medusa/src/services/event-bus.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L57) ___ @@ -39,7 +39,17 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L46) +[packages/medusa/src/services/event-bus.ts:71](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L71) + +___ + +### eventToSubscribersMap\_ + +• `Protected` `Readonly` **eventToSubscribersMap\_**: `Map`<`string` \| `symbol`, `SubscriberDescriptor`[]\> + +#### Defined in + +[packages/medusa/src/services/event-bus.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L62) ___ @@ -49,7 +59,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L39) +[packages/medusa/src/services/event-bus.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L61) ___ @@ -59,7 +69,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L37) +[packages/medusa/src/services/event-bus.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L59) ___ @@ -69,17 +79,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L36) - -___ - -### observers\_ - -• `Protected` `Readonly` **observers\_**: `Map`<`string` \| `symbol`, `Subscriber`<`unknown`\>[]\> - -#### Defined in - -[packages/medusa/src/services/event-bus.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L40) +[packages/medusa/src/services/event-bus.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L58) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L43) +[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L68) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L41) +[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L66) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L42) +[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L67) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L44) +[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L69) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L38) +[packages/medusa/src/services/event-bus.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L60) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L45) +[packages/medusa/src/services/event-bus.ts:70](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L70) ## Methods @@ -176,7 +176,7 @@ void #### Defined in -[packages/medusa/src/services/event-bus.ts:279](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L279) +[packages/medusa/src/services/event-bus.ts:416](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L416) ___ @@ -198,7 +198,7 @@ Calls all subscribers when an event occurs. | :------ | :------ | :------ | | `eventName` | `string` | the name of the event to be process. | | `data` | `T` | the data to send to the subscriber. | -| `options` | `EmitOptions` | options to add the job with | +| `options` | `Record`<`string`, `unknown`\> & `EmitOptions` | options to add the job with | #### Returns @@ -208,7 +208,7 @@ the job from our queue #### Defined in -[packages/medusa/src/services/event-bus.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L167) +[packages/medusa/src/services/event-bus.ts:223](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L223) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L209) +[packages/medusa/src/services/event-bus.ts:280](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L280) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:199](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L199) +[packages/medusa/src/services/event-bus.ts:270](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L270) ___ @@ -250,13 +250,13 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:204](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L204) +[packages/medusa/src/services/event-bus.ts:275](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L275) ___ ### subscribe -▸ **subscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md) +▸ **subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](EventBusService.md) Adds a function to a list of event subscribers. @@ -265,7 +265,8 @@ Adds a function to a list of event subscribers. | Name | Type | Description | | :------ | :------ | :------ | | `event` | `string` \| `symbol` | the event that the subscriber will listen for. | -| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. | +| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event | +| `context?` | `SubscriberContext` | context to use when attaching subscriber happens. Subscribers must return a Promise. | #### Returns @@ -275,7 +276,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:127](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L127) +[packages/medusa/src/services/event-bus.ts:153](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L153) ___ @@ -300,7 +301,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:145](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L145) +[packages/medusa/src/services/event-bus.ts:196](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L196) ___ @@ -320,13 +321,13 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L96) +[packages/medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L121) ___ ### worker\_ -▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`[]\> +▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`\> Handles incoming jobs. @@ -340,17 +341,14 @@ Handles incoming jobs. | Name | Type | Description | | :------ | :------ | :------ | -| `job` | `Object` | The job object | -| `job.data` | `Object` | - | -| `job.data.data` | `T` | - | -| `job.data.eventName` | `string` | - | +| `job` | `BullJob`<`T`\> | The job object | #### Returns -`Promise`<`unknown`[]\> +`Promise`<`unknown`\> resolves to the results of the subscriber calls. #### Defined in -[packages/medusa/src/services/event-bus.ts:244](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L244) +[packages/medusa/src/services/event-bus.ts:315](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L315) diff --git a/docs/content/references/services/classes/FulfillmentProviderService.md b/docs/content/references/services/classes/FulfillmentProviderService.md index 2ab5fd7132..eea3429cb9 100644 --- a/docs/content/references/services/classes/FulfillmentProviderService.md +++ b/docs/content/references/services/classes/FulfillmentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L47) +[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L43) +[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L43) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L45) +[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L45) ___ @@ -88,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L40) +[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L40) ___ @@ -102,7 +102,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L41) +[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L41) ## Methods @@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L151) +[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L151) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L126) +[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L126) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L144) +[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L144) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L111) +[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L111) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L169) +[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L169) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L71) +[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L71) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L79) +[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L79) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L57) +[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L57) ___ @@ -326,7 +326,7 @@ document to fetch #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L188) +[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L188) ___ @@ -348,7 +348,7 @@ the payment fulfillment provider #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L100) +[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L100) ___ @@ -372,7 +372,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L131) +[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L131) ___ @@ -414,7 +414,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L164) +[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment-provider.ts#L164) ___ @@ -438,4 +438,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/FulfillmentService.md b/docs/content/references/services/classes/FulfillmentService.md index 166bb05f1d..ebcc21d275 100644 --- a/docs/content/references/services/classes/FulfillmentService.md +++ b/docs/content/references/services/classes/FulfillmentService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L47) +[packages/medusa/src/services/fulfillment.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L50) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L42) +[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L43) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L43) +[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L44) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L45) +[packages/medusa/src/services/fulfillment.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L46) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L40) +[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L41) ___ @@ -108,7 +108,17 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L36) +[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L37) + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Defined in + +[packages/medusa/src/services/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L48) ___ @@ -118,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L41) +[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L42) ___ @@ -128,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L39) +[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L40) ___ @@ -138,7 +148,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L44) +[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L45) ___ @@ -152,7 +162,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L37) +[packages/medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L38) ## Methods @@ -191,7 +201,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -217,13 +227,13 @@ the result of the save operation #### Defined in -[packages/medusa/src/services/fulfillment.ts:260](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L260) +[packages/medusa/src/services/fulfillment.ts:269](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L269) ___ ### createFulfillment -▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<`Fulfillment`[]\> +▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`, `context?`): `Promise`<`Fulfillment`[]\> Creates an order fulfillment If items needs to be fulfilled by different provider, we make @@ -237,6 +247,8 @@ those partitions. | `order` | `CreateFulfillmentOrder` | order to create fulfillment for | | `itemsToFulfill` | `FulFillmentItemType`[] | the items in the order to fulfill | | `custom` | `Partial`<`Fulfillment`\> | potential custom values to add | +| `context` | `Object` | - | +| `context.locationId?` | `string` | - | #### Returns @@ -246,7 +258,7 @@ the created fulfillments #### Defined in -[packages/medusa/src/services/fulfillment.ts:205](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L205) +[packages/medusa/src/services/fulfillment.ts:211](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L211) ___ @@ -273,7 +285,7 @@ the shipped fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:310](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L310) +[packages/medusa/src/services/fulfillment.ts:321](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L321) ___ @@ -298,7 +310,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L109) +[packages/medusa/src/services/fulfillment.ts:115](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L115) ___ @@ -319,7 +331,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L71) +[packages/medusa/src/services/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L76) ___ @@ -344,7 +356,7 @@ the fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L166) +[packages/medusa/src/services/fulfillment.ts:172](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L172) ___ @@ -368,7 +380,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -397,7 +409,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L134) +[packages/medusa/src/services/fulfillment.ts:140](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L140) ___ @@ -421,4 +433,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/GiftCardService.md b/docs/content/references/services/classes/GiftCardService.md index a052ba1702..dd26953407 100644 --- a/docs/content/references/services/classes/GiftCardService.md +++ b/docs/content/references/services/classes/GiftCardService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L47) +[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L38) +[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L38) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L34) +[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L34) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L36) +[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L36) ___ @@ -98,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L40) +[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L40) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L37) +[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L37) ___ @@ -122,7 +122,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L41) +[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L41) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L43) +[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L43) ## Methods @@ -177,7 +177,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -201,7 +201,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L153) +[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L153) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L138) +[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L138) ___ @@ -245,7 +245,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L322) +[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L322) ___ @@ -268,7 +268,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L114) +[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L114) ___ @@ -291,7 +291,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L85) +[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L85) ___ @@ -316,7 +316,7 @@ the gift card #### Defined in -[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L242) +[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L242) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L256) +[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L256) ___ @@ -358,7 +358,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L208) +[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L208) ___ @@ -382,7 +382,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -407,7 +407,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L276) +[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L276) ___ @@ -431,7 +431,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) ___ @@ -449,7 +449,7 @@ the generated gift card code #### Defined in -[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L69) +[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L69) ___ @@ -475,4 +475,4 @@ the tax rate for the gift card #### Defined in -[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L189) +[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/gift-card.ts#L189) diff --git a/docs/content/references/services/classes/IdempotencyKeyService.md b/docs/content/references/services/classes/IdempotencyKeyService.md index 228080f829..1f2525e4a2 100644 --- a/docs/content/references/services/classes/IdempotencyKeyService.md +++ b/docs/content/references/services/classes/IdempotencyKeyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L25) +[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L25) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L23) +[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L23) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L20) +[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L20) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L21) +[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L21) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -155,7 +155,7 @@ the created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L67) +[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L67) ___ @@ -182,7 +182,7 @@ the existing or created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L41) +[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L41) ___ @@ -206,7 +206,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L116) +[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L116) ___ @@ -230,7 +230,7 @@ idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L85) +[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L85) ___ @@ -254,7 +254,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -289,7 +289,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L145) +[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L145) ___ @@ -313,7 +313,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) ___ @@ -342,4 +342,4 @@ new updated idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L174) +[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/idempotency-key.ts#L174) diff --git a/docs/content/references/services/classes/InventoryService.md b/docs/content/references/services/classes/InventoryService.md deleted file mode 100644 index b75693dd2b..0000000000 --- a/docs/content/references/services/classes/InventoryService.md +++ /dev/null @@ -1,232 +0,0 @@ -# Class: InventoryService - -## Hierarchy - -- `TransactionBaseService` - - ↳ **`InventoryService`** - -## Constructors - -### constructor - -• **new InventoryService**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `InventoryServiceProps` | - -#### Overrides - -TransactionBaseService.constructor - -#### Defined in - -[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L18) - -## Properties - -### \_\_configModule\_\_ - -• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> - -#### Inherited from - -TransactionBaseService.\_\_configModule\_\_ - -#### Defined in - -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) - -___ - -### \_\_container\_\_ - -• `Protected` `Readonly` **\_\_container\_\_**: `any` - -#### Inherited from - -TransactionBaseService.\_\_container\_\_ - -#### Defined in - -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) - -___ - -### manager\_ - -• `Protected` **manager\_**: `EntityManager` - -#### Overrides - -TransactionBaseService.manager\_ - -#### Defined in - -[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L15) - -___ - -### productVariantService\_ - -• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md) - -#### Defined in - -[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L13) - -___ - -### transactionManager\_ - -• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` - -#### Overrides - -TransactionBaseService.transactionManager\_ - -#### Defined in - -[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L16) - -## Methods - -### adjustInventory - -▸ **adjustInventory**(`variantId`, `adjustment`): `Promise`<`undefined` \| `ProductVariant`\> - -Updates the inventory of a variant based on a given adjustment. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `variantId` | `string` | the id of the variant to update | -| `adjustment` | `number` | the number to adjust the inventory quantity by | - -#### Returns - -`Promise`<`undefined` \| `ProductVariant`\> - -resolves to the update result. - -#### Defined in - -[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L31) - -___ - -### atomicPhase\_ - -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> - -Wraps some work within a transactional block. If the service already has -a transaction manager attached this will be reused, otherwise a new -transaction manager is created. - -#### Type parameters - -| Name | -| :------ | -| `TResult` | -| `TError` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | - -#### Returns - -`Promise`<`TResult`\> - -the result of the transactional work - -#### Inherited from - -TransactionBaseService.atomicPhase\_ - -#### Defined in - -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) - -___ - -### confirmInventory - -▸ **confirmInventory**(`variantId`, `quantity`): `Promise`<`boolean`\> - -Checks if the inventory of a variant can cover a given quantity. Will -return true if the variant doesn't have managed inventory or if the variant -allows backorders or if the inventory quantity is greater than `quantity`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `variantId` | `undefined` \| ``null`` \| `string` | the id of the variant to check | -| `quantity` | `number` | the number of units to check availability for | - -#### Returns - -`Promise`<`boolean`\> - -true if the inventory covers the quantity - -#### Defined in - -[packages/medusa/src/services/inventory.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L64) - -___ - -### shouldRetryTransaction\_ - -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | - -#### Returns - -`boolean` - -#### Inherited from - -TransactionBaseService.shouldRetryTransaction\_ - -#### Defined in - -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) - -___ - -### withTransaction - -▸ **withTransaction**(`transactionManager?`): [`InventoryService`](InventoryService.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionManager?` | `EntityManager` | - -#### Returns - -[`InventoryService`](InventoryService.md) - -#### Inherited from - -TransactionBaseService.withTransaction - -#### Defined in - -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/LineItemAdjustmentService.md b/docs/content/references/services/classes/LineItemAdjustmentService.md index 6455df92a0..644c030181 100644 --- a/docs/content/references/services/classes/LineItemAdjustmentService.md +++ b/docs/content/references/services/classes/LineItemAdjustmentService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L39) +[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L39) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L37) +[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L37) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L36) +[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L36) ___ @@ -88,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L33) +[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L33) ___ @@ -102,7 +102,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L34) +[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L34) ## Methods @@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -165,7 +165,7 @@ line item adjustment #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L90) +[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L90) ___ @@ -190,7 +190,7 @@ a line item adjustment or undefined if no adjustment was created #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:255](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L255) +[packages/medusa/src/services/line-item-adjustment.ts:255](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L255) ___ @@ -216,7 +216,7 @@ otherwise returns an array of line item adjustments for each line item in the ca #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:283](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L283) +[packages/medusa/src/services/line-item-adjustment.ts:283](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L283) ___ @@ -240,7 +240,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L155) +[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L155) ___ @@ -266,7 +266,7 @@ a line item adjustment or undefined if no adjustment was created #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:184](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L184) +[packages/medusa/src/services/line-item-adjustment.ts:184](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L184) ___ @@ -291,7 +291,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L138) +[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L138) ___ @@ -316,7 +316,7 @@ the line item adjustment. #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L58) +[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L58) ___ @@ -340,7 +340,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -365,7 +365,7 @@ line item adjustment #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L107) +[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item-adjustment.ts#L107) ___ @@ -389,4 +389,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/LineItemService.md b/docs/content/references/services/classes/LineItemService.md index d46d429616..b0c2947ee7 100644 --- a/docs/content/references/services/classes/LineItemService.md +++ b/docs/content/references/services/classes/LineItemService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/line-item.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L60) +[packages/medusa/src/services/line-item.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L60) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L51) +[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L51) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L56) +[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L56) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L50) +[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L50) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L57) +[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L57) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L49) +[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L49) ___ @@ -116,7 +116,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L46) +[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L46) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L54) +[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L54) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L53) +[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L53) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L52) +[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L52) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L55) +[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L55) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L58) +[packages/medusa/src/services/line-item.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L58) ___ @@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L47) +[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L47) ## Methods @@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -240,11 +240,11 @@ ___ | `data.claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } | | `data.claim_order_id?` | `string` | | `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | -| `data.description?` | `string` | +| `data.description?` | ``null`` \| `string` | | `data.discount_total?` | ``null`` \| `number` | -| `data.fulfilled_quantity?` | `number` | +| `data.fulfilled_quantity?` | ``null`` \| `number` | | `data.gift_card_total?` | ``null`` \| `number` | -| `data.has_shipping?` | `boolean` | +| `data.has_shipping?` | ``null`` \| `boolean` | | `data.id?` | `string` | | `data.includes_tax?` | `boolean` | | `data.is_giftcard?` | `boolean` | @@ -259,8 +259,8 @@ ___ | `data.original_total?` | ``null`` \| `number` | | `data.quantity?` | `number` | | `data.refundable?` | ``null`` \| `number` | -| `data.returned_quantity?` | `number` | -| `data.shipped_quantity?` | `number` | +| `data.returned_quantity?` | ``null`` \| `number` | +| `data.shipped_quantity?` | ``null`` \| `number` | | `data.should_merge?` | `boolean` | | `data.subtotal?` | ``null`` \| `number` | | `data.swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } | @@ -273,7 +273,7 @@ ___ | `data.unit_price?` | `number` | | `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | | `data.variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 29 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 22 more ...; updated\_at?: { ...; } \| undefined; } | -| `data.variant_id?` | `string` | +| `data.variant_id?` | ``null`` \| `string` | | `options` | `Object` | | `options.setOriginalLineItemId?` | `boolean` | @@ -283,7 +283,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:488](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L488) +[packages/medusa/src/services/line-item.ts:489](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L489) ___ @@ -314,7 +314,7 @@ the created line item #### Defined in -[packages/medusa/src/services/line-item.ts:369](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L369) +[packages/medusa/src/services/line-item.ts:370](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L370) ___ @@ -340,7 +340,7 @@ the created line items #### Defined in -[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L135) +[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L135) ___ @@ -373,7 +373,7 @@ a new line item tax line #### Defined in -[packages/medusa/src/services/line-item.ts:480](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L480) +[packages/medusa/src/services/line-item.ts:481](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L481) ___ @@ -397,7 +397,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item.ts:440](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L440) +[packages/medusa/src/services/line-item.ts:441](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L441) ___ @@ -421,7 +421,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item.ts:459](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L459) +[packages/medusa/src/services/line-item.ts:460](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L460) ___ @@ -453,7 +453,7 @@ Generate a single or multiple line item without persisting the data into the db #### Defined in -[packages/medusa/src/services/line-item.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L195) +[packages/medusa/src/services/line-item.ts:196](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L196) ___ @@ -483,7 +483,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:298](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L298) +[packages/medusa/src/services/line-item.ts:299](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L299) ___ @@ -504,7 +504,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L88) +[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L88) ___ @@ -529,7 +529,7 @@ the line item #### Defined in -[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L108) +[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L108) ___ @@ -553,7 +553,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -578,7 +578,7 @@ the updated line item(s) #### Defined in -[packages/medusa/src/services/line-item.ts:397](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L397) +[packages/medusa/src/services/line-item.ts:398](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L398) ___ @@ -607,7 +607,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:559](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L559) +[packages/medusa/src/services/line-item.ts:560](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/line-item.ts#L560) ___ @@ -631,4 +631,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/MiddlewareService.md b/docs/content/references/services/classes/MiddlewareService.md index 01b85e1715..4c7d8e18e6 100644 --- a/docs/content/references/services/classes/MiddlewareService.md +++ b/docs/content/references/services/classes/MiddlewareService.md @@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L22) +[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L22) ## Properties @@ -20,7 +20,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L17) +[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L17) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L18) +[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L18) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L19) +[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L19) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L20) +[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L20) ## Methods @@ -75,7 +75,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L60) +[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L60) ___ @@ -100,7 +100,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L79) +[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L79) ___ @@ -122,7 +122,7 @@ Adds a middleware function to be called before cart creation #### Defined in -[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L96) +[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L96) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L29) +[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L29) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L34) +[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L34) ___ @@ -185,7 +185,7 @@ Adds post authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L106) +[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L106) ___ @@ -207,7 +207,7 @@ Adds pre authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L117) +[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L117) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L123) +[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L123) ___ @@ -245,4 +245,4 @@ nothing if the middleware is a function #### Defined in -[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L43) +[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/middleware.ts#L43) diff --git a/docs/content/references/services/classes/NewTotalsService.md b/docs/content/references/services/classes/NewTotalsService.md index d07737c4e2..7b547c81bf 100644 --- a/docs/content/references/services/classes/NewTotalsService.md +++ b/docs/content/references/services/classes/NewTotalsService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L68) +[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L68) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L65) +[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L65) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L61) +[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L61) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L66) +[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L66) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L64) +[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L64) ___ @@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L62) +[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L62) ## Methods @@ -149,7 +149,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -175,7 +175,7 @@ Calculate and return the gift cards totals #### Defined in -[packages/medusa/src/services/new-totals.ts:455](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L455) +[packages/medusa/src/services/new-totals.ts:455](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L455) ___ @@ -206,7 +206,7 @@ Calculate and return the gift cards totals based on their transactions #### Defined in -[packages/medusa/src/services/new-totals.ts:534](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L534) +[packages/medusa/src/services/new-totals.ts:534](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L534) ___ @@ -236,7 +236,7 @@ Return the amount that can be refund on a line item #### Defined in -[packages/medusa/src/services/new-totals.ts:340](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L340) +[packages/medusa/src/services/new-totals.ts:340](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L340) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:410](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L410) +[packages/medusa/src/services/new-totals.ts:410](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L410) ___ @@ -289,7 +289,7 @@ Calculate and return the items totals for either the legacy calculation or the n #### Defined in -[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L90) +[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L90) ___ @@ -317,7 +317,7 @@ Calculate and return the legacy calculated totals using the tax rate #### Defined in -[packages/medusa/src/services/new-totals.ts:263](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L263) +[packages/medusa/src/services/new-totals.ts:263](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L263) ___ @@ -346,7 +346,7 @@ Calculate and return the totals for an item #### Defined in -[packages/medusa/src/services/new-totals.ts:158](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L158) +[packages/medusa/src/services/new-totals.ts:158](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L158) ___ @@ -373,7 +373,7 @@ Calculate and return the shipping methods totals for either the legacy calculati #### Defined in -[packages/medusa/src/services/new-totals.ts:580](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L580) +[packages/medusa/src/services/new-totals.ts:580](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L580) ___ @@ -399,7 +399,7 @@ Calculate and return the shipping method totals legacy using teh tax rate #### Defined in -[packages/medusa/src/services/new-totals.ts:738](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L738) +[packages/medusa/src/services/new-totals.ts:738](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L738) ___ @@ -426,7 +426,7 @@ Calculate and return the shipping method totals #### Defined in -[packages/medusa/src/services/new-totals.ts:655](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L655) +[packages/medusa/src/services/new-totals.ts:655](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/new-totals.ts#L655) ___ @@ -450,7 +450,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -474,4 +474,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/NoteService.md b/docs/content/references/services/classes/NoteService.md index f7cd991079..9c46503304 100644 --- a/docs/content/references/services/classes/NoteService.md +++ b/docs/content/references/services/classes/NoteService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L29) +[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L29) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L27) +[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L27) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L24) +[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L24) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L26) +[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L26) ___ @@ -100,7 +100,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L25) +[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L25) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L18) +[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L18) ## Methods @@ -157,7 +157,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -183,7 +183,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L103) +[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L103) ___ @@ -205,7 +205,7 @@ Deletes a given note #### Defined in -[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L161) +[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L161) ___ @@ -230,7 +230,7 @@ notes related to the given search. #### Defined in -[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L82) +[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L82) ___ @@ -255,7 +255,7 @@ which resolves to the requested note. #### Defined in -[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L47) +[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L47) ___ @@ -279,7 +279,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -304,7 +304,7 @@ resolves to the updated element #### Defined in -[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L139) +[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/note.ts#L139) ___ @@ -328,4 +328,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/NotificationService.md b/docs/content/references/services/classes/NotificationService.md index c98d55bf1c..82dce23fdb 100644 --- a/docs/content/references/services/classes/NotificationService.md +++ b/docs/content/references/services/classes/NotificationService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L36) +[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L36) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L27) +[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L27) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L28) +[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L28) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L31) +[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L31) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L23) +[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L23) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L34) +[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L34) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L32) +[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L32) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L26) +[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L26) ___ @@ -140,7 +140,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L24) +[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L24) ## Methods @@ -179,7 +179,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -206,7 +206,7 @@ the result of notification subscribed #### Defined in -[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L174) +[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L174) ___ @@ -231,7 +231,7 @@ the notifications that satisfy the query. #### Defined in -[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L86) +[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L86) ___ @@ -254,7 +254,7 @@ used to generate on demand invoices or other documents. #### Defined in -[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L62) +[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L62) ___ @@ -276,7 +276,7 @@ Takes a list of notification provider ids and persists them in the database. #### Defined in -[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L70) +[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L70) ___ @@ -302,7 +302,7 @@ the newly created notification #### Defined in -[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L254) +[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L254) ___ @@ -327,7 +327,7 @@ the notification #### Defined in -[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L107) +[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L107) ___ @@ -352,7 +352,7 @@ the notification provider #### Defined in -[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L155) +[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L155) ___ @@ -379,7 +379,7 @@ the created notification #### Defined in -[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L206) +[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L206) ___ @@ -403,7 +403,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -426,7 +426,7 @@ Subscribes a given provider to an event. #### Defined in -[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L134) +[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/notification.ts#L134) ___ @@ -450,4 +450,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/OauthService.md b/docs/content/references/services/classes/OauthService.md index a0d0701586..d60141c5d3 100644 --- a/docs/content/references/services/classes/OauthService.md +++ b/docs/content/references/services/classes/OauthService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L31) +[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L31) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L27) +[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L27) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L29) +[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L29) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L26) +[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L26) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L19) +[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L19) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L28) +[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L28) ___ @@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L20) +[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L20) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L21) +[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L21) ## Methods @@ -176,7 +176,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L88) +[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L88) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L122) +[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L122) ___ @@ -238,7 +238,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L80) +[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L80) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L156) +[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L156) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L112) +[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L112) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L57) +[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L57) ___ @@ -318,7 +318,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L41) +[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L41) ___ @@ -342,7 +342,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -363,7 +363,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L101) +[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/oauth.ts#L101) ___ @@ -387,4 +387,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/OrderEditItemChangeService.md b/docs/content/references/services/classes/OrderEditItemChangeService.md index ff8d24ac2b..d633faa144 100644 --- a/docs/content/references/services/classes/OrderEditItemChangeService.md +++ b/docs/content/references/services/classes/OrderEditItemChangeService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L34) +[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L34) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L30) +[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L30) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L31) +[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L31) ___ @@ -86,7 +86,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L26) +[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L26) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L29) +[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L29) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L32) +[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L32) ___ @@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L27) +[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L27) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L21) +[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L21) ## Methods @@ -176,7 +176,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L86) +[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L86) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L102) +[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L102) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L73) +[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L73) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L51) +[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit-item-change.ts#L51) ___ @@ -282,7 +282,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -306,4 +306,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/OrderEditService.md b/docs/content/references/services/classes/OrderEditService.md index c09049848d..7f81f13ac4 100644 --- a/docs/content/references/services/classes/OrderEditService.md +++ b/docs/content/references/services/classes/OrderEditService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L65) +[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L65) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L60) +[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L60) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L62) +[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L62) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L59) +[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L59) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L52) +[packages/medusa/src/services/order-edit.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L52) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L63) +[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L63) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L55) +[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L55) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L57) +[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L57) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L61) +[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L61) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L58) +[packages/medusa/src/services/order-edit.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L58) ___ @@ -160,7 +160,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L53) +[packages/medusa/src/services/order-edit.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L53) ___ @@ -181,7 +181,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L43) +[packages/medusa/src/services/order-edit.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L43) ## Methods @@ -202,7 +202,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:554](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L554) +[packages/medusa/src/services/order-edit.ts:554](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L554) ___ @@ -241,7 +241,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:698](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L698) +[packages/medusa/src/services/order-edit.ts:698](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L698) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:737](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L737) +[packages/medusa/src/services/order-edit.ts:737](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L737) ___ @@ -307,7 +307,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:214](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L214) +[packages/medusa/src/services/order-edit.ts:214](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L214) ___ @@ -330,7 +330,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:316](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L316) +[packages/medusa/src/services/order-edit.ts:316](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L316) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:540](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L540) +[packages/medusa/src/services/order-edit.ts:540](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L540) ___ @@ -370,7 +370,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:292](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L292) +[packages/medusa/src/services/order-edit.ts:292](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L292) ___ @@ -390,7 +390,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:810](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L810) +[packages/medusa/src/services/order-edit.ts:810](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L810) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:626](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L626) +[packages/medusa/src/services/order-edit.ts:626](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L626) ___ @@ -433,7 +433,7 @@ Compute and return the different totals from the order edit id #### Defined in -[packages/medusa/src/services/order-edit.ts:155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L155) +[packages/medusa/src/services/order-edit.ts:155](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L155) ___ @@ -454,7 +454,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:143](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L143) +[packages/medusa/src/services/order-edit.ts:143](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L143) ___ @@ -475,7 +475,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L119) +[packages/medusa/src/services/order-edit.ts:119](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L119) ___ @@ -495,7 +495,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:497](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L497) +[packages/medusa/src/services/order-edit.ts:497](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L497) ___ @@ -516,7 +516,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:440](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L440) +[packages/medusa/src/services/order-edit.ts:440](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L440) ___ @@ -538,7 +538,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:658](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L658) +[packages/medusa/src/services/order-edit.ts:658](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L658) ___ @@ -559,7 +559,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L90) +[packages/medusa/src/services/order-edit.ts:90](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L90) ___ @@ -580,7 +580,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:789](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L789) +[packages/medusa/src/services/order-edit.ts:789](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L789) ___ @@ -604,7 +604,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -655,7 +655,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:263](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L263) +[packages/medusa/src/services/order-edit.ts:263](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L263) ___ @@ -682,7 +682,7 @@ Create or update order edit item change line item and apply the quantity #### Defined in -[packages/medusa/src/services/order-edit.ts:367](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L367) +[packages/medusa/src/services/order-edit.ts:367](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L367) ___ @@ -706,7 +706,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) ___ @@ -726,4 +726,4 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:856](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L856) +[packages/medusa/src/services/order-edit.ts:856](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order-edit.ts#L856) diff --git a/docs/content/references/services/classes/OrderService.md b/docs/content/references/services/classes/OrderService.md index b0ada02e3a..9bc32aed54 100644 --- a/docs/content/references/services/classes/OrderService.md +++ b/docs/content/references/services/classes/OrderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L124) +[packages/medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L129) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L117) +[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L121) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L116) +[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L120) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L104) +[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L108) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L108) +[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L112) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L119) +[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L123) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L121) +[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L124) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L122) +[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L125) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L109) +[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L113) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L110) +[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L114) ___ @@ -152,17 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L118) - -___ - -### inventoryService\_ - -• `Protected` `Readonly` **inventoryService\_**: [`InventoryService`](InventoryService.md) - -#### Defined in - -[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L120) +[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L122) ___ @@ -172,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L111) +[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L115) ___ @@ -186,7 +176,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L100) +[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L104) ___ @@ -196,7 +186,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L113) +[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L117) ___ @@ -206,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L103) +[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L107) ___ @@ -216,7 +206,17 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L105) +[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L109) + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L127) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L115) +[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L119) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L106) +[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L110) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L107) +[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L111) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L114) +[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L118) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L112) +[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L116) ___ @@ -280,7 +280,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L101) +[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L105) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L81) +[packages/medusa/src/services/order.ts:85](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L85) ## Methods @@ -334,7 +334,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:962](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L962) +[packages/medusa/src/services/order.ts:949](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L949) ___ @@ -359,7 +359,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1487) +[packages/medusa/src/services/order.ts:1496](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1496) ___ @@ -398,7 +398,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -424,7 +424,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1114) +[packages/medusa/src/services/order.ts:1101](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1101) ___ @@ -448,7 +448,7 @@ updated order #### Defined in -[packages/medusa/src/services/order.ts:1424](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1424) +[packages/medusa/src/services/order.ts:1433](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1433) ___ @@ -472,7 +472,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1192](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1192) +[packages/medusa/src/services/order.ts:1200](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1200) ___ @@ -494,7 +494,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:508](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L508) +[packages/medusa/src/services/order.ts:517](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L517) ___ @@ -518,7 +518,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/order.ts:536](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L536) +[packages/medusa/src/services/order.ts:545](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L545) ___ @@ -538,6 +538,7 @@ to their respective fulfillment provider. | `orderId` | `string` | id of order to cancel. | | `itemsToFulfill` | `FulFillmentItemType`[] | items to fulfil. | | `config` | `Object` | the config to cancel. | +| `config.location_id?` | `string` | - | | `config.metadata?` | `Record`<`string`, `unknown`\> | - | | `config.no_notification?` | `boolean` | - | @@ -549,7 +550,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1297](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1297) +[packages/medusa/src/services/order.ts:1305](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1305) ___ @@ -571,7 +572,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:748](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L748) +[packages/medusa/src/services/order.ts:735](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L735) ___ @@ -600,7 +601,7 @@ the result of the refund operation. #### Defined in -[packages/medusa/src/services/order.ts:1513](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1513) +[packages/medusa/src/services/order.ts:1522](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1522) ___ @@ -631,7 +632,7 @@ the resulting order following the update. #### Defined in -[packages/medusa/src/services/order.ts:802](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L802) +[packages/medusa/src/services/order.ts:789](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L789) ___ @@ -654,7 +655,7 @@ Calculate and attach the different total fields on the object #### Defined in -[packages/medusa/src/services/order.ts:1713](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1713) +[packages/medusa/src/services/order.ts:1722](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1722) ___ @@ -675,7 +676,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:1579](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1579) +[packages/medusa/src/services/order.ts:1588](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1588) ___ @@ -701,7 +702,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/order.ts:1466](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1466) +[packages/medusa/src/services/order.ts:1475](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1475) ___ @@ -721,7 +722,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:1939](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1939) +[packages/medusa/src/services/order.ts:1948](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1948) ___ @@ -744,7 +745,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:178](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L178) +[packages/medusa/src/services/order.ts:183](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L183) ___ @@ -767,7 +768,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L195) +[packages/medusa/src/services/order.ts:200](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L200) ___ @@ -799,7 +800,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1864](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1864) +[packages/medusa/src/services/order.ts:1873](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1873) ___ @@ -824,7 +825,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:334](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L334) +[packages/medusa/src/services/order.ts:343](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L343) ___ @@ -849,7 +850,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:430](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L430) +[packages/medusa/src/services/order.ts:439](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L439) ___ @@ -874,7 +875,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:471](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L471) +[packages/medusa/src/services/order.ts:480](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L480) ___ @@ -895,7 +896,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:375](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L375) +[packages/medusa/src/services/order.ts:384](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L384) ___ @@ -917,7 +918,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:413](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L413) +[packages/medusa/src/services/order.ts:422](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L422) ___ @@ -941,7 +942,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -967,7 +968,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:258](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L258) +[packages/medusa/src/services/order.ts:267](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L267) ___ @@ -994,7 +995,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/order.ts:1025](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1025) +[packages/medusa/src/services/order.ts:1012](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1012) ___ @@ -1019,7 +1020,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:890](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L890) +[packages/medusa/src/services/order.ts:877](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L877) ___ @@ -1044,7 +1045,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:930](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L930) +[packages/medusa/src/services/order.ts:917](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L917) ___ @@ -1073,7 +1074,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/order.ts:1264](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1264) +[packages/medusa/src/services/order.ts:1272](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/order.ts#L1272) ___ @@ -1097,4 +1098,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PaymentCollectionService.md b/docs/content/references/services/classes/PaymentCollectionService.md index 55a70ed89f..c81d3fa728 100644 --- a/docs/content/references/services/classes/PaymentCollectionService.md +++ b/docs/content/references/services/classes/PaymentCollectionService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L51) +[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L51) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L47) +[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L47) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L45) +[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L45) ___ @@ -86,7 +86,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L43) +[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L43) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L49) +[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L49) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L46) +[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L46) ___ @@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L44) +[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L44) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L36) +[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L36) ## Methods @@ -178,7 +178,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -204,7 +204,7 @@ the payment collection and its payment session. #### Defined in -[packages/medusa/src/services/payment-collection.ts:587](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L587) +[packages/medusa/src/services/payment-collection.ts:531](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L531) ___ @@ -228,7 +228,7 @@ the payment collection created. #### Defined in -[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L111) +[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L111) ___ @@ -252,7 +252,7 @@ the payment collection removed. #### Defined in -[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L180) +[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L180) ___ @@ -273,7 +273,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L218) +[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L218) ___ @@ -297,7 +297,7 @@ the payment session authorized. #### Defined in -[packages/medusa/src/services/payment-collection.ts:558](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L558) +[packages/medusa/src/services/payment-collection.ts:502](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L502) ___ @@ -323,7 +323,7 @@ the new payment session created. #### Defined in -[packages/medusa/src/services/payment-collection.ts:468](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L468) +[packages/medusa/src/services/payment-collection.ts:412](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L412) ___ @@ -348,7 +348,7 @@ the payment collection. #### Defined in -[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L74) +[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L74) ___ @@ -374,13 +374,13 @@ the payment collection and its payment session. #### Defined in -[packages/medusa/src/services/payment-collection.ts:360](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L360) +[packages/medusa/src/services/payment-collection.ts:366](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L366) ___ ### setPaymentSessionsBatch -▸ **setPaymentSessionsBatch**(`paymentCollectionId`, `sessionsInput`, `customerId`): `Promise`<`PaymentCollection`\> +▸ **setPaymentSessionsBatch**(`paymentCollectionOrId`, `sessionsInput`, `customerId`): `Promise`<`PaymentCollection`\> Manages multiple payment sessions of a payment collection. @@ -388,7 +388,7 @@ Manages multiple payment sessions of a payment collection. | Name | Type | Description | | :------ | :------ | :------ | -| `paymentCollectionId` | `string` | the id of the payment collection | +| `paymentCollectionOrId` | `string` \| `PaymentCollection` | the id of the payment collection | | `sessionsInput` | `PaymentCollectionsSessionsBatchInput`[] | array containing payment session info | | `customerId` | `string` | the id of the customer | @@ -400,7 +400,7 @@ the payment collection and its payment sessions. #### Defined in -[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L233) +[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L233) ___ @@ -424,7 +424,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -466,7 +466,7 @@ the payment collection updated. #### Defined in -[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L146) +[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-collection.ts#L146) ___ @@ -490,4 +490,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PaymentProviderService.md b/docs/content/references/services/classes/PaymentProviderService.md index 942bb1f40a..8bdbdbc22b 100644 --- a/docs/content/references/services/classes/PaymentProviderService.md +++ b/docs/content/references/services/classes/PaymentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment-provider.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L65) +[packages/medusa/src/services/payment-provider.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L65) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L54) +[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L54) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L60) +[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L60) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L63) +[packages/medusa/src/services/payment-provider.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L63) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L61) +[packages/medusa/src/services/payment-provider.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L61) ___ @@ -108,7 +108,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L52) +[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L52) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L57) +[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L57) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L58) +[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L58) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L55) +[packages/medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L55) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L59) +[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L59) ___ @@ -162,7 +162,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L53) +[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L53) ## Methods @@ -201,7 +201,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -222,13 +222,13 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:394](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L394) +[packages/medusa/src/services/payment-provider.ts:396](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L396) ___ -### buildPaymentContext +### buildPaymentProcessorContext -▸ `Protected` **buildPaymentContext**(`cartOrData`): `Cart` & `PaymentContext` +▸ `Protected` **buildPaymentProcessorContext**(`cartOrData`): `Cart` & `PaymentContext` Build the create session context for both legacy and new API @@ -244,7 +244,7 @@ Build the create session context for both legacy and new API #### Defined in -[packages/medusa/src/services/payment-provider.ts:643](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L643) +[packages/medusa/src/services/payment-provider.ts:645](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L645) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:450](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L450) +[packages/medusa/src/services/payment-provider.ts:452](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L452) ___ @@ -284,7 +284,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:475](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L475) +[packages/medusa/src/services/payment-provider.ts:477](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L477) ___ @@ -304,7 +304,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:356](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L356) +[packages/medusa/src/services/payment-provider.ts:358](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L358) ___ @@ -335,7 +335,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:181](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L181) +[packages/medusa/src/services/payment-provider.ts:181](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L181) ___ @@ -355,7 +355,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:302](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L302) +[packages/medusa/src/services/payment-provider.ts:304](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L304) ___ @@ -375,7 +375,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:470](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L470) +[packages/medusa/src/services/payment-provider.ts:472](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L472) ___ @@ -389,7 +389,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:98](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L98) +[packages/medusa/src/services/payment-provider.ts:98](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L98) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:133](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L133) +[packages/medusa/src/services/payment-provider.ts:133](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L133) ___ @@ -435,7 +435,7 @@ Process the collected data. Can be used every time we need to process some colle #### Defined in -[packages/medusa/src/services/payment-provider.ts:736](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L736) +[packages/medusa/src/services/payment-provider.ts:734](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L734) ___ @@ -464,7 +464,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:241](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L241) +[packages/medusa/src/services/payment-provider.ts:239](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L239) ___ @@ -487,7 +487,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:580](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L580) +[packages/medusa/src/services/payment-provider.ts:582](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L582) ___ @@ -510,7 +510,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:495](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L495) +[packages/medusa/src/services/payment-provider.ts:497](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L497) ___ @@ -530,7 +530,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L79) +[packages/medusa/src/services/payment-provider.ts:79](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L79) ___ @@ -551,7 +551,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L105) +[packages/medusa/src/services/payment-provider.ts:105](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L105) ___ @@ -581,7 +581,7 @@ the payment provider #### Defined in -[packages/medusa/src/services/payment-provider.ts:332](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L332) +[packages/medusa/src/services/payment-provider.ts:334](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L334) ___ @@ -602,7 +602,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:620](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L620) +[packages/medusa/src/services/payment-provider.ts:622](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L622) ___ @@ -623,7 +623,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L146) +[packages/medusa/src/services/payment-provider.ts:146](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L146) ___ @@ -641,6 +641,7 @@ Create or update a Payment session data. | `data` | `Object` | | `data.amount?` | `number` | | `data.cartId?` | `string` | +| `data.isInitiated?` | `boolean` | | `data.isSelected?` | `boolean` | | `data.payment_session_id?` | `string` | | `data.sessionData` | `Record`<`string`, `unknown`\> | @@ -652,7 +653,7 @@ Create or update a Payment session data. #### Defined in -[packages/medusa/src/services/payment-provider.ts:682](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L682) +[packages/medusa/src/services/payment-provider.ts:684](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L684) ___ @@ -676,7 +677,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -699,7 +700,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:382](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L382) +[packages/medusa/src/services/payment-provider.ts:384](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L384) ___ @@ -727,7 +728,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:271](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L271) +[packages/medusa/src/services/payment-provider.ts:269](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L269) ___ @@ -748,7 +749,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:429](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L429) +[packages/medusa/src/services/payment-provider.ts:431](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment-provider.ts#L431) ___ @@ -772,4 +773,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PaymentService.md b/docs/content/references/services/classes/PaymentService.md index efee5b7e12..124253ef41 100644 --- a/docs/content/references/services/classes/PaymentService.md +++ b/docs/content/references/services/classes/PaymentService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L40) +[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L40) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L28) +[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L28) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L26) +[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L26) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L29) +[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L29) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L30) +[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L30) ___ @@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L27) +[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L27) ___ @@ -131,7 +131,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L31) +[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L31) ## Methods @@ -170,7 +170,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -194,7 +194,7 @@ the payment captured. #### Defined in -[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L161) +[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L161) ___ @@ -218,7 +218,7 @@ the payment created. #### Defined in -[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L96) +[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L96) ___ @@ -245,7 +245,7 @@ the refund created. #### Defined in -[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L210) +[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L210) ___ @@ -270,7 +270,7 @@ the payment. #### Defined in -[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L61) +[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L61) ___ @@ -294,7 +294,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -321,7 +321,7 @@ the payment updated. #### Defined in -[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L127) +[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/payment.ts#L127) ___ @@ -345,4 +345,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PriceListService.md b/docs/content/references/services/classes/PriceListService.md index da3b528cc6..9e522987a3 100644 --- a/docs/content/references/services/classes/PriceListService.md +++ b/docs/content/references/services/classes/PriceListService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L57) +[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L57) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L48) +[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L48) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L55) +[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L55) ___ @@ -88,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L45) +[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L45) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L53) +[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L53) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L52) +[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L52) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L50) +[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L50) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L54) +[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L54) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L49) +[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L49) ___ @@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L46) +[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L46) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L51) +[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L51) ## Methods @@ -192,7 +192,7 @@ updated `prices` list #### Defined in -[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L519) +[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L519) ___ @@ -218,7 +218,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L218) +[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L218) ___ @@ -257,7 +257,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -281,7 +281,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L258) +[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L258) ___ @@ -305,7 +305,7 @@ created Price List #### Defined in -[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L119) +[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L119) ___ @@ -330,7 +330,7 @@ empty promise #### Defined in -[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L272) +[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L272) ___ @@ -355,7 +355,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L243) +[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L243) ___ @@ -376,7 +376,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L446) +[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L446) ___ @@ -397,7 +397,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L483) +[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L483) ___ @@ -422,7 +422,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L292) +[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L292) ___ @@ -447,7 +447,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L316) +[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L316) ___ @@ -470,7 +470,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L364) +[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L364) ___ @@ -493,7 +493,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L412) +[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L412) ___ @@ -518,7 +518,7 @@ the collection. #### Defined in -[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L88) +[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L88) ___ @@ -542,7 +542,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -567,7 +567,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L167) +[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L167) ___ @@ -588,7 +588,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L345) +[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/price-list.ts#L345) ___ @@ -612,4 +612,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PricingService.md b/docs/content/references/services/classes/PricingService.md index 18de58dfb0..49de9487a4 100644 --- a/docs/content/references/services/classes/PricingService.md +++ b/docs/content/references/services/classes/PricingService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L44) +[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L44) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L42) +[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L42) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L36) +[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L36) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L40) +[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L40) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L41) +[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L41) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L38) +[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L38) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L39) +[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L39) ___ @@ -132,7 +132,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L37) +[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L37) ## Methods @@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -196,7 +196,7 @@ The tax related variant prices. #### Defined in -[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L105) +[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L105) ___ @@ -221,7 +221,7 @@ The pricing context #### Defined in -[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L69) +[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L69) ___ @@ -247,7 +247,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L389) +[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L389) ___ @@ -272,7 +272,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L407) +[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L407) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L351) +[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L351) ___ @@ -319,7 +319,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L214) +[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L214) ___ @@ -348,7 +348,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L253) +[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L253) ___ @@ -370,7 +370,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L167) +[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L167) ___ @@ -402,7 +402,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L294) +[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L294) ___ @@ -427,7 +427,7 @@ The shipping option prices #### Defined in -[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L493) +[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L493) ___ @@ -452,7 +452,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L450) +[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L450) ___ @@ -477,7 +477,7 @@ A list of shipping options with prices #### Defined in -[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L555) +[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L555) ___ @@ -502,7 +502,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L425) +[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/pricing.ts#L425) ___ @@ -526,7 +526,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -550,4 +550,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductCategoryService.md b/docs/content/references/services/classes/ProductCategoryService.md new file mode 100644 index 0000000000..bc6bad7bb4 --- /dev/null +++ b/docs/content/references/services/classes/ProductCategoryService.md @@ -0,0 +1,283 @@ +# Class: ProductCategoryService + +Provides layer to manipulate product categories. + +## Hierarchy + +- `TransactionBaseService` + + ↳ **`ProductCategoryService`** + +## Constructors + +### constructor + +• **new ProductCategoryService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `InjectedDependencies` | + +#### Overrides + +TransactionBaseService.constructor + +#### Defined in + +[packages/medusa/src/services/product-category.ts:23](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L23) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/product-category.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L19) + +___ + +### productCategoryRepo\_ + +• `Protected` `Readonly` **productCategoryRepo\_**: typeof `ProductCategoryRepository` + +#### Defined in + +[packages/medusa/src/services/product-category.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L20) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/product-category.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L21) + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) + +___ + +### create + +▸ **create**(`productCategory`): `Promise`<`ProductCategory`\> + +Creates a product category + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategory` | `CreateProductCategoryInput` | params used to create | + +#### Returns + +`Promise`<`ProductCategory`\> + +created product category + +#### Defined in + +[packages/medusa/src/services/product-category.ts:108](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L108) + +___ + +### delete + +▸ **delete**(`productCategoryId`): `Promise`<`void`\> + +Deletes a product category + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryId` | `string` | is the id of the product category to delete | + +#### Returns + +`Promise`<`void`\> + +a promise + +#### Defined in + +[packages/medusa/src/services/product-category.ts:125](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L125) + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[`ProductCategory`[], `number`]\> + +Lists product category based on the provided parameters and includes the count of +product category that match the query. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | `QuerySelector`<`ProductCategory`\> | +| `config` | `FindConfig`<`ProductCategory`\> | + +#### Returns + +`Promise`<[`ProductCategory`[], `number`]\> + +an array containing the product category as + the first element and the total count of product category that matches the query + as the second element. + +#### Defined in + +[packages/medusa/src/services/product-category.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L38) + +___ + +### retrieve + +▸ **retrieve**(`productCategoryId`, `config?`): `Promise`<`ProductCategory`\> + +Retrieves a product category by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryId` | `string` | the id of the product category to retrieve. | +| `config` | `FindConfig`<`ProductCategory`\> | the config of the product category to retrieve. | + +#### Returns + +`Promise`<`ProductCategory`\> + +the product category. + +#### Defined in + +[packages/medusa/src/services/product-category.ts:70](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-category.ts#L70) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductCategoryService`](ProductCategoryService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductCategoryService`](ProductCategoryService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductCollectionService.md b/docs/content/references/services/classes/ProductCollectionService.md index c3eee30edc..afefdc768a 100644 --- a/docs/content/references/services/classes/ProductCollectionService.md +++ b/docs/content/references/services/classes/ProductCollectionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L34) +[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L34) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L29) +[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L29) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L26) +[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L26) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L31) +[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L31) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L32) +[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L32) ___ @@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L27) +[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L27) ## Methods @@ -133,7 +133,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L181) +[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L181) ___ @@ -172,7 +172,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -196,7 +196,7 @@ created collection #### Defined in -[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L114) +[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L114) ___ @@ -220,7 +220,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L163) +[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L163) ___ @@ -247,7 +247,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L219) +[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L219) ___ @@ -272,7 +272,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L236) +[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L236) ___ @@ -293,7 +293,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L198) +[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L198) ___ @@ -318,7 +318,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L54) +[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L54) ___ @@ -343,7 +343,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L88) +[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L88) ___ @@ -367,7 +367,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -392,7 +392,7 @@ update collection #### Defined in -[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L133) +[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-collection.ts#L133) ___ @@ -416,4 +416,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductService.md b/docs/content/references/services/classes/ProductService.md index c55c95f8b0..7c98f44daa 100644 --- a/docs/content/references/services/classes/ProductService.md +++ b/docs/content/references/services/classes/ProductService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L73) +[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L73) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L63) +[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L63) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L64) +[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L64) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L60) +[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L60) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L52) +[packages/medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L52) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L55) +[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L55) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L56) +[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L56) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L59) +[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L59) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L58) +[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L58) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L57) +[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L57) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L61) +[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L61) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L62) +[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L62) ___ @@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L53) +[packages/medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L53) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L67) +[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L67) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L66) +[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L66) ## Methods @@ -235,7 +235,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/product.ts:663](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L663) +[packages/medusa/src/services/product.ts:663](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L663) ___ @@ -274,7 +274,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -298,7 +298,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/product.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L164) +[packages/medusa/src/services/product.ts:164](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L164) ___ @@ -322,7 +322,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product.ts:376](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L376) +[packages/medusa/src/services/product.ts:376](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L376) ___ @@ -347,7 +347,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product.ts:629](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L629) +[packages/medusa/src/services/product.ts:629](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L629) ___ @@ -372,7 +372,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:828](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L828) +[packages/medusa/src/services/product.ts:828](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L828) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:299](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L299) +[packages/medusa/src/services/product.ts:299](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L299) ___ @@ -417,7 +417,7 @@ Check if the product is assigned to at least one of the provided sales channels. #### Defined in -[packages/medusa/src/services/product.ts:354](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L354) +[packages/medusa/src/services/product.ts:354](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L354) ___ @@ -442,7 +442,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L110) +[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L110) ___ @@ -470,7 +470,7 @@ an array containing the products as #### Defined in -[packages/medusa/src/services/product.ts:134](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L134) +[packages/medusa/src/services/product.ts:134](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L134) ___ @@ -490,7 +490,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:339](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L339) +[packages/medusa/src/services/product.ts:339](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L339) ___ @@ -504,7 +504,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:330](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L330) +[packages/medusa/src/services/product.ts:330](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L330) ___ @@ -536,7 +536,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product.ts:900](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L900) +[packages/medusa/src/services/product.ts:900](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L900) ___ @@ -557,7 +557,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:706](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L706) +[packages/medusa/src/services/product.ts:706](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L706) ___ @@ -583,7 +583,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:179](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L179) +[packages/medusa/src/services/product.ts:179](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L179) ___ @@ -609,7 +609,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:223](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L223) +[packages/medusa/src/services/product.ts:223](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L223) ___ @@ -635,7 +635,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:202](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L202) +[packages/medusa/src/services/product.ts:202](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L202) ___ @@ -660,7 +660,7 @@ product option #### Defined in -[packages/medusa/src/services/product.ts:809](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L809) +[packages/medusa/src/services/product.ts:809](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L809) ___ @@ -685,7 +685,7 @@ an array of variants #### Defined in -[packages/medusa/src/services/product.ts:281](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L281) +[packages/medusa/src/services/product.ts:281](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L281) ___ @@ -711,7 +711,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:245](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L245) +[packages/medusa/src/services/product.ts:245](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L245) ___ @@ -735,7 +735,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -762,7 +762,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product.ts:471](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L471) +[packages/medusa/src/services/product.ts:471](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L471) ___ @@ -789,7 +789,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:752](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L752) +[packages/medusa/src/services/product.ts:752](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product.ts#L752) ___ @@ -813,4 +813,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductTypeService.md b/docs/content/references/services/classes/ProductTypeService.md index 34b6b534cb..1435207648 100644 --- a/docs/content/references/services/classes/ProductTypeService.md +++ b/docs/content/references/services/classes/ProductTypeService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L15) +[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-type.ts#L15) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L10) +[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-type.ts#L10) ___ @@ -80,7 +80,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L11) +[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-type.ts#L11) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L13) +[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-type.ts#L13) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -154,7 +154,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L55) +[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-type.ts#L55) ___ @@ -179,7 +179,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L72) +[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-type.ts#L72) ___ @@ -205,7 +205,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L30) +[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-type.ts#L30) ___ @@ -229,7 +229,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -253,4 +253,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductVariantInventoryService.md b/docs/content/references/services/classes/ProductVariantInventoryService.md new file mode 100644 index 0000000000..edcaa6464f --- /dev/null +++ b/docs/content/references/services/classes/ProductVariantInventoryService.md @@ -0,0 +1,529 @@ +# Class: ProductVariantInventoryService + +## Hierarchy + +- `TransactionBaseService` + + ↳ **`ProductVariantInventoryService`** + +## Constructors + +### constructor + +• **new ProductVariantInventoryService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `InjectedDependencies` | + +#### Overrides + +TransactionBaseService.constructor + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L30) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### inventoryService\_ + +• `Protected` `Readonly` **inventoryService\_**: `IInventoryService` + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L28) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L22) + +___ + +### productVariantService\_ + +• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md) + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L26) + +___ + +### salesChannelLocationService\_ + +• `Protected` `Readonly` **salesChannelLocationService\_**: [`SalesChannelLocationService`](SalesChannelLocationService.md) + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L25) + +___ + +### stockLocationService\_ + +• `Protected` `Readonly` **stockLocationService\_**: `IStockLocationService` + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L27) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:23](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L23) + +## Methods + +### adjustInventory + +▸ **adjustInventory**(`variantId`, `locationId`, `quantity`): `Promise`<`void`\> + +Adjusts inventory of a variant on a location + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | +| `locationId` | `string` | location id | +| `quantity` | `number` | quantity to adjust | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:534](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L534) + +___ + +### adjustReservationsQuantityByLineItem + +▸ **adjustReservationsQuantityByLineItem**(`lineItemId`, `variantId`, `locationId`, `quantity`): `Promise`<`void`\> + +Adjusts the quantity of reservations for a line item by a given amount. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItemId` | `string` | The ID of the line item | +| `variantId` | `string` | The ID of the variant | +| `locationId` | `string` | The ID of the location to prefer adjusting quantities at | +| `quantity` | `number` | The amount to adjust the quantity by | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:394](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L394) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) + +___ + +### attachInventoryItem + +▸ **attachInventoryItem**(`variantId`, `inventoryItemId`, `quantity?`): `Promise`<`ProductVariantInventoryItem`\> + +Attach a variant to an inventory item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | +| `inventoryItemId` | `string` | inventory item id | +| `quantity?` | `number` | quantity of variant to attach | + +#### Returns + +`Promise`<`ProductVariantInventoryItem`\> + +the variant inventory item + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:238](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L238) + +___ + +### confirmInventory + +▸ **confirmInventory**(`variantId`, `quantity`, `context?`): `Promise`<`Boolean`\> + +confirms if requested inventory is available + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | id of the variant to confirm inventory for | +| `quantity` | `number` | quantity of inventory to confirm is available | +| `context` | `Object` | optionally include a sales channel if applicable | +| `context.salesChannelId?` | ``null`` \| `string` | - | + +#### Returns + +`Promise`<`Boolean`\> + +boolean indicating if inventory is available + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L54) + +___ + +### deleteReservationsByLineItem + +▸ **deleteReservationsByLineItem**(`lineItemId`, `variantId`, `quantity`): `Promise`<`void`\> + +delete a reservation of variant quantity + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItemId` | `string` | line item id | +| `variantId` | `string` | variant id | +| `quantity` | `number` | quantity to release | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:502](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L502) + +___ + +### detachInventoryItem + +▸ **detachInventoryItem**(`variantId`, `inventoryItemId`): `Promise`<`void`\> + +Remove a variant from an inventory item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | +| `inventoryItemId` | `string` | inventory item id | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:298](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L298) + +___ + +### listByItem + +▸ **listByItem**(`itemIds`): `Promise`<`ProductVariantInventoryItem`[]\> + +list registered inventory items + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemIds` | `string`[] | list inventory item ids | + +#### Returns + +`Promise`<`ProductVariantInventoryItem`[]\> + +list of inventory items + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:156](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L156) + +___ + +### listByVariant + +▸ `Private` **listByVariant**(`variantId`): `Promise`<`ProductVariantInventoryItem`[]\> + +List inventory items for a specific variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` \| `string`[] | variant id | + +#### Returns + +`Promise`<`ProductVariantInventoryItem`[]\> + +variant inventory items for the variant id + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:175](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L175) + +___ + +### listInventoryItemsByVariant + +▸ **listInventoryItemsByVariant**(`variantId`): `Promise`<`InventoryItemDTO`[]\> + +lists inventory items for a given variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | + +#### Returns + +`Promise`<`InventoryItemDTO`[]\> + +lidt of inventory items for the variant + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:216](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L216) + +___ + +### listVariantsByItem + +▸ **listVariantsByItem**(`itemId`): `Promise`<`ProductVariant`[]\> + +lists variant by inventory item id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemId` | `string` | item id | + +#### Returns + +`Promise`<`ProductVariant`[]\> + +a list of product variants that are associated with the item id + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:198](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L198) + +___ + +### reserveQuantity + +▸ **reserveQuantity**(`variantId`, `quantity`, `context?`): `Promise`<`void`\> + +Reserves a quantity of a variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | +| `quantity` | `number` | quantity to reserve | +| `context` | `ReserveQuantityContext` | optional parameters | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:326](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L326) + +___ + +### retrieve + +▸ **retrieve**(`inventoryItemId`, `variantId`): `Promise`<`ProductVariantInventoryItem`\> + +Retrieves a product variant inventory item by its inventory item ID and variant ID. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `inventoryItemId` | `string` | The ID of the inventory item to retrieve. | +| `variantId` | `string` | The ID of the variant to retrieve. | + +#### Returns + +`Promise`<`ProductVariantInventoryItem`\> + +A promise that resolves with the product variant inventory item. + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:127](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L127) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) + +___ + +### validateInventoryAtLocation + +▸ **validateInventoryAtLocation**(`items`, `locationId`): `Promise`<`void`\> + +Validate stock at a location for fulfillment items + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `items` | `LineItem`[] | Fulfillment Line items to validate quantities for | +| `locationId` | `string` | Location to validate stock at | + +#### Returns + +`Promise`<`void`\> + +nothing if successful, throws error if not + +#### Defined in + +[packages/medusa/src/services/product-variant-inventory.ts:459](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant-inventory.ts#L459) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductVariantService.md b/docs/content/references/services/classes/ProductVariantService.md index e2336a3de7..17f3ebca94 100644 --- a/docs/content/references/services/classes/ProductVariantService.md +++ b/docs/content/references/services/classes/ProductVariantService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L53) +[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L53) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L51) +[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L51) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L46) +[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L46) ___ @@ -86,7 +86,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L41) +[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L41) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L49) +[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L49) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L48) +[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L48) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L50) +[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L50) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L45) +[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L45) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L44) +[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L44) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L47) +[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L47) ___ @@ -160,7 +160,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L42) +[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L42) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L35) +[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L35) ## Methods @@ -208,7 +208,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L498) +[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L498) ___ @@ -247,7 +247,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -273,7 +273,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L147) +[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L147) ___ @@ -298,7 +298,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L651) +[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L651) ___ @@ -324,7 +324,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L525) +[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L525) ___ @@ -352,7 +352,7 @@ an array containing the products as the first element and the total #### Defined in -[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L724) +[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L724) ___ @@ -379,7 +379,7 @@ the price specific to the region #### Defined in -[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L374) +[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L374) ___ @@ -402,7 +402,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L593) +[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L593) ___ @@ -425,7 +425,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L552) +[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L552) ___ @@ -457,7 +457,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L685) +[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L685) ___ @@ -482,7 +482,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L83) +[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L83) ___ @@ -507,7 +507,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L111) +[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L111) ___ @@ -532,7 +532,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L439) +[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L439) ___ @@ -557,7 +557,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L403) +[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L403) ___ @@ -581,7 +581,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -608,7 +608,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L255) +[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L255) ___ @@ -635,7 +635,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L460) +[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L460) ___ @@ -661,7 +661,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L333) +[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L333) ___ @@ -685,4 +685,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/RegionService.md b/docs/content/references/services/classes/RegionService.md index 9ef8930719..8c97222e2a 100644 --- a/docs/content/references/services/classes/RegionService.md +++ b/docs/content/references/services/classes/RegionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L67) +[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L67) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L59) +[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L59) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L60) +[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L60) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L54) +[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L54) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L52) +[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L52) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L64) +[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L64) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L57) +[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L57) ___ @@ -128,7 +128,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L50) +[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L50) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L62) +[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L62) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L56) +[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L56) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L58) +[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L58) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L55) +[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L55) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L65) +[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L65) ___ @@ -192,7 +192,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L51) +[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L51) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L44) +[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L44) ## Methods @@ -235,7 +235,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L580) +[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L580) ___ @@ -261,7 +261,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L710) +[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L710) ___ @@ -287,7 +287,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L659) +[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L659) ___ @@ -326,7 +326,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -350,7 +350,7 @@ the newly created region #### Defined in -[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L117) +[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L117) ___ @@ -374,7 +374,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L549) +[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L549) ___ @@ -399,7 +399,7 @@ result of the find operation #### Defined in -[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L529) +[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L529) ___ @@ -424,7 +424,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L618) +[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L618) ___ @@ -449,7 +449,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L798) +[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L798) ___ @@ -474,7 +474,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L759) +[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L759) ___ @@ -499,7 +499,7 @@ the region #### Defined in -[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L494) +[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L494) ___ @@ -524,7 +524,7 @@ a Region with country code #### Defined in -[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L437) +[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L437) ___ @@ -548,7 +548,7 @@ region with the matching name #### Defined in -[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L474) +[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L474) ___ @@ -572,7 +572,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -597,7 +597,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L190) +[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L190) ___ @@ -623,7 +623,7 @@ the validated Country #### Defined in -[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L388) +[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L388) ___ @@ -651,7 +651,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L363) +[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L363) ___ @@ -683,7 +683,7 @@ the validated region data #### Defined in -[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L261) +[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L261) ___ @@ -711,7 +711,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L347) +[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/region.ts#L347) ___ @@ -735,4 +735,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ReturnReasonService.md b/docs/content/references/services/classes/ReturnReasonService.md index cfb5606c0b..c3b0c35f9e 100644 --- a/docs/content/references/services/classes/ReturnReasonService.md +++ b/docs/content/references/services/classes/ReturnReasonService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L21) +[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L21) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L18) +[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L18) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L16) +[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L16) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L19) +[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L19) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L29) +[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L29) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L117) +[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L117) ___ @@ -192,7 +192,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L72) +[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L72) ___ @@ -217,7 +217,7 @@ the order document #### Defined in -[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L91) +[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L91) ___ @@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L50) +[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return-reason.ts#L50) ___ @@ -286,4 +286,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ReturnService.md b/docs/content/references/services/classes/ReturnService.md index 93eb063ff5..b76be6afb6 100644 --- a/docs/content/references/services/classes/ReturnService.md +++ b/docs/content/references/services/classes/ReturnService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L63) +[packages/medusa/src/services/return.ts:67](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L67) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,17 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L58) - -___ - -### inventoryService\_ - -• `Protected` `Readonly` **inventoryService\_**: [`InventoryService`](InventoryService.md) - -#### Defined in - -[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L60) +[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L61) ___ @@ -82,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L55) +[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L58) ___ @@ -96,7 +86,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L49) +[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L52) ___ @@ -106,7 +96,17 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L61) +[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L63) + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Defined in + +[packages/medusa/src/services/return.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L65) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L54) +[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L57) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L59) +[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L62) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L53) +[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L56) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L57) +[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L60) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L56) +[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L59) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L52) +[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L55) ___ @@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L50) +[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L53) ## Methods @@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -243,7 +243,7 @@ the updated Return #### Defined in -[packages/medusa/src/services/return.ts:159](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L159) +[packages/medusa/src/services/return.ts:164](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L164) ___ @@ -269,7 +269,7 @@ the created return #### Defined in -[packages/medusa/src/services/return.ts:344](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L344) +[packages/medusa/src/services/return.ts:349](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L349) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:490](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L490) +[packages/medusa/src/services/return.ts:495](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L495) ___ @@ -315,7 +315,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/return.ts:101](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L101) +[packages/medusa/src/services/return.ts:106](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L106) ___ @@ -338,13 +338,13 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return.ts:141](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L141) +[packages/medusa/src/services/return.ts:146](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L146) ___ ### receive -▸ **receive**(`returnId`, `receivedItems`, `refundAmount?`, `allowMismatch?`): `Promise`<`Return`\> +▸ **receive**(`returnId`, `receivedItems`, `refundAmount?`, `allowMismatch?`, `context?`): `Promise`<`Return`\> Registers a previously requested return as received. This will create a refund to the customer. If the returned items don't match the requested @@ -362,6 +362,8 @@ mismatches. | `receivedItems` | `OrdersReturnItem`[] | `undefined` | the items received after return. | | `refundAmount?` | `number` | `undefined` | the amount to return | | `allowMismatch` | `boolean` | `false` | whether to ignore return/received product mismatch | +| `context` | `Object` | `{}` | - | +| `context.locationId?` | `string` | `undefined` | - | #### Returns @@ -371,7 +373,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/return.ts:561](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L561) +[packages/medusa/src/services/return.ts:566](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L566) ___ @@ -396,7 +398,7 @@ the return #### Defined in -[packages/medusa/src/services/return.ts:257](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L257) +[packages/medusa/src/services/return.ts:262](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L262) ___ @@ -417,7 +419,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L285) +[packages/medusa/src/services/return.ts:290](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L290) ___ @@ -441,7 +443,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -462,7 +464,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:310](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L310) +[packages/medusa/src/services/return.ts:315](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L315) ___ @@ -500,11 +502,11 @@ a line item where the quantity is set to the requested | `claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } | | `claim_order_id?` | `string` | | `created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | -| `description?` | `string` | +| `description?` | ``null`` \| `string` | | `discount_total?` | ``null`` \| `number` | -| `fulfilled_quantity?` | `number` | +| `fulfilled_quantity?` | ``null`` \| `number` | | `gift_card_total?` | ``null`` \| `number` | -| `has_shipping?` | `boolean` | +| `has_shipping?` | ``null`` \| `boolean` | | `id?` | `string` | | `includes_tax?` | `boolean` | | `is_giftcard?` | `boolean` | @@ -519,8 +521,8 @@ a line item where the quantity is set to the requested | `original_total?` | ``null`` \| `number` | | `quantity?` | `number` | | `refundable?` | ``null`` \| `number` | -| `returned_quantity?` | `number` | -| `shipped_quantity?` | `number` | +| `returned_quantity?` | ``null`` \| `number` | +| `shipped_quantity?` | ``null`` \| `number` | | `should_merge?` | `boolean` | | `subtotal?` | ``null`` \| `number` | | `swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } | @@ -533,11 +535,11 @@ a line item where the quantity is set to the requested | `unit_price?` | `number` | | `updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | | `variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 29 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 22 more ...; updated\_at?: { ...; } \| undefined; } | -| `variant_id?` | `string` | +| `variant_id?` | ``null`` \| `string` | #### Defined in -[packages/medusa/src/services/return.ts:215](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L215) +[packages/medusa/src/services/return.ts:220](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L220) ___ @@ -565,7 +567,7 @@ when statuses are not sufficient for returns. #### Defined in -[packages/medusa/src/services/return.ts:185](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L185) +[packages/medusa/src/services/return.ts:190](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/return.ts#L190) ___ @@ -589,4 +591,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SalesChannelInventoryService.md b/docs/content/references/services/classes/SalesChannelInventoryService.md new file mode 100644 index 0000000000..fa98637b52 --- /dev/null +++ b/docs/content/references/services/classes/SalesChannelInventoryService.md @@ -0,0 +1,82 @@ +# Class: SalesChannelInventoryService + +## Constructors + +### constructor + +• **new SalesChannelInventoryService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `InjectedDependencies` | + +#### Defined in + +[packages/medusa/src/services/sales-channel-inventory.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L21) + +## Properties + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L18) + +___ + +### inventoryService\_ + +• `Protected` `Readonly` **inventoryService\_**: `IInventoryService` + +#### Defined in + +[packages/medusa/src/services/sales-channel-inventory.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L19) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Defined in + +[packages/medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L15) + +___ + +### salesChannelLocationService\_ + +• `Protected` `Readonly` **salesChannelLocationService\_**: [`SalesChannelLocationService`](SalesChannelLocationService.md) + +#### Defined in + +[packages/medusa/src/services/sales-channel-inventory.ts:17](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L17) + +## Methods + +### retrieveAvailableItemQuantity + +▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `itemId`): `Promise`<`number`\> + +Retrieves the available quantity of an item across all sales channel locations + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | Sales channel id | +| `itemId` | `string` | Item id | + +#### Returns + +`Promise`<`number`\> + +available quantity of item across all sales channel locations + +#### Defined in + +[packages/medusa/src/services/sales-channel-inventory.ts:39](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L39) diff --git a/docs/content/references/services/classes/SalesChannelLocationService.md b/docs/content/references/services/classes/SalesChannelLocationService.md new file mode 100644 index 0000000000..f9e8198cec --- /dev/null +++ b/docs/content/references/services/classes/SalesChannelLocationService.md @@ -0,0 +1,276 @@ +# Class: SalesChannelLocationService + +Service for managing the stock locations of sales channels + +## Hierarchy + +- `TransactionBaseService` + + ↳ **`SalesChannelLocationService`** + +## Constructors + +### constructor + +• **new SalesChannelLocationService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `InjectedDependencies` | + +#### Overrides + +TransactionBaseService.constructor + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L26) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### eventBusService + +• `Protected` `Readonly` **eventBusService**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L23) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L19) + +___ + +### salesChannelService\_ + +• `Protected` `Readonly` **salesChannelService\_**: [`SalesChannelService`](SalesChannelService.md) + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L22) + +___ + +### stockLocationService + +• `Protected` `Readonly` **stockLocationService**: `IStockLocationService` + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L24) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L20) + +## Methods + +### associateLocation + +▸ **associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\> + +Associates a sales channel with a stock location. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The ID of the sales channel. | +| `locationId` | `string` | The ID of the stock location. | + +#### Returns + +`Promise`<`void`\> + +A promise that resolves when the association has been created. + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L64) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) + +___ + +### listLocations + +▸ **listLocations**(`salesChannelId`): `Promise`<`string`[]\> + +Lists the stock locations associated with a sales channel. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The ID of the sales channel. | + +#### Returns + +`Promise`<`string`[]\> + +A promise that resolves with an array of location IDs. + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:87](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L87) + +___ + +### removeLocation + +▸ **removeLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\> + +Removes an association between a sales channel and a stock location. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The ID of the sales channel. | +| `locationId` | `string` | The ID of the stock location. | + +#### Returns + +`Promise`<`void`\> + +A promise that resolves when the association has been removed. + +#### Defined in + +[packages/medusa/src/services/sales-channel-location.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-location.ts#L47) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](SalesChannelLocationService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`SalesChannelLocationService`](SalesChannelLocationService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SalesChannelService.md b/docs/content/references/services/classes/SalesChannelService.md index 8a11127827..214f9f6e2a 100644 --- a/docs/content/references/services/classes/SalesChannelService.md +++ b/docs/content/references/services/classes/SalesChannelService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L37) +[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L37) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L34) +[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L34) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L30) +[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L30) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L33) +[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L33) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L35) +[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L35) ___ @@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L31) +[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L31) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L24) +[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L24) ## Methods @@ -153,7 +153,7 @@ the sales channel on which the products have been added #### Defined in -[packages/medusa/src/services/sales-channel.ts:319](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L319) +[packages/medusa/src/services/sales-channel.ts:319](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L319) ___ @@ -192,7 +192,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -219,7 +219,7 @@ the created channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:176](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L176) +[packages/medusa/src/services/sales-channel.ts:176](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L176) ___ @@ -237,7 +237,7 @@ the sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:266](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L266) +[packages/medusa/src/services/sales-channel.ts:266](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L266) ___ @@ -261,7 +261,7 @@ To use this feature please enable the corresponding feature flag in your medusa #### Defined in -[packages/medusa/src/services/sales-channel.ts:227](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L227) +[packages/medusa/src/services/sales-channel.ts:227](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L227) ___ @@ -289,7 +289,7 @@ an array containing the sales channels as #### Defined in -[packages/medusa/src/services/sales-channel.ts:141](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L141) +[packages/medusa/src/services/sales-channel.ts:141](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L141) ___ @@ -314,7 +314,7 @@ the sales channel on which the products have been removed #### Defined in -[packages/medusa/src/services/sales-channel.ts:298](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L298) +[packages/medusa/src/services/sales-channel.ts:298](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L298) ___ @@ -339,7 +339,7 @@ a sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L99) +[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L99) ___ @@ -364,7 +364,7 @@ a sales channel with matching name #### Defined in -[packages/medusa/src/services/sales-channel.ts:120](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L120) +[packages/medusa/src/services/sales-channel.ts:120](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L120) ___ @@ -389,7 +389,7 @@ a single SC matching the query or throws #### Defined in -[packages/medusa/src/services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L59) +[packages/medusa/src/services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L59) ___ @@ -413,7 +413,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -434,7 +434,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:193](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L193) +[packages/medusa/src/services/sales-channel.ts:193](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel.ts#L193) ___ @@ -458,4 +458,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SearchService.md b/docs/content/references/services/classes/SearchService.md index d53f98a440..62f9550a1f 100644 --- a/docs/content/references/services/classes/SearchService.md +++ b/docs/content/references/services/classes/SearchService.md @@ -25,7 +25,7 @@ AbstractSearchService.constructor #### Defined in -[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L18) +[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L18) ## Properties @@ -39,7 +39,7 @@ AbstractSearchService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -53,7 +53,7 @@ AbstractSearchService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -67,7 +67,7 @@ AbstractSearchService.isDefault #### Defined in -[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L11) +[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L11) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L15) +[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L15) ___ @@ -91,7 +91,7 @@ AbstractSearchService.manager\_ #### Defined in -[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L13) +[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L13) ___ @@ -105,7 +105,7 @@ AbstractSearchService.options\_ #### Defined in -[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L16) +[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L16) ___ @@ -119,7 +119,7 @@ AbstractSearchService.transactionManager\_ #### Defined in -[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L14) +[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L14) ## Accessors @@ -137,7 +137,7 @@ AbstractSearchService.options #### Defined in -[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/search-service.ts#L82) +[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/search-service.ts#L82) ## Methods @@ -163,7 +163,7 @@ AbstractSearchService.addDocuments #### Defined in -[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L43) +[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L43) ___ @@ -202,7 +202,7 @@ AbstractSearchService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -227,7 +227,7 @@ AbstractSearchService.createIndex #### Defined in -[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L31) +[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L31) ___ @@ -251,7 +251,7 @@ AbstractSearchService.deleteAllDocuments #### Defined in -[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L72) +[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L72) ___ @@ -276,7 +276,7 @@ AbstractSearchService.deleteDocument #### Defined in -[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L63) +[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L63) ___ @@ -300,7 +300,7 @@ AbstractSearchService.getIndex #### Defined in -[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L37) +[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L37) ___ @@ -326,7 +326,7 @@ AbstractSearchService.replaceDocuments #### Defined in -[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L53) +[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L53) ___ @@ -352,7 +352,7 @@ AbstractSearchService.search #### Defined in -[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L78) +[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L78) ___ @@ -376,7 +376,7 @@ AbstractSearchService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -401,7 +401,7 @@ AbstractSearchService.updateSettings #### Defined in -[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L89) +[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/search.ts#L89) ___ @@ -425,4 +425,4 @@ AbstractSearchService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ShippingOptionService.md b/docs/content/references/services/classes/ShippingOptionService.md index 469452b120..b8c3078dda 100644 --- a/docs/content/references/services/classes/ShippingOptionService.md +++ b/docs/content/references/services/classes/ShippingOptionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L55) +[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L55) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L50) +[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L50) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L52) +[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L52) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L49) +[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L49) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L48) +[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L48) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L44) +[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L44) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L45) +[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L45) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L47) +[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L47) ___ @@ -142,7 +142,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L53) +[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L53) ## Methods @@ -168,7 +168,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:709](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L709) +[packages/medusa/src/services/shipping-option.ts:709](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L709) ___ @@ -207,7 +207,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -233,7 +233,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L451) +[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L451) ___ @@ -259,7 +259,7 @@ the resulting shipping method. #### Defined in -[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L278) +[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L278) ___ @@ -283,7 +283,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-option.ts:687](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L687) +[packages/medusa/src/services/shipping-option.ts:687](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L687) ___ @@ -307,7 +307,7 @@ removed shipping methods #### Defined in -[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L258) +[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L258) ___ @@ -335,7 +335,7 @@ the price of the shipping option. #### Defined in -[packages/medusa/src/services/shipping-option.ts:768](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L768) +[packages/medusa/src/services/shipping-option.ts:768](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L768) ___ @@ -358,7 +358,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L148) +[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L148) ___ @@ -381,7 +381,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L164) +[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L164) ___ @@ -405,7 +405,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:738](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L738) +[packages/medusa/src/services/shipping-option.ts:738](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L738) ___ @@ -433,7 +433,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L182) +[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L182) ___ @@ -457,7 +457,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -484,7 +484,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L579) +[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L579) ___ @@ -510,7 +510,7 @@ the resulting shipping method #### Defined in -[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L229) +[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L229) ___ @@ -531,7 +531,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L408) +[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L408) ___ @@ -558,7 +558,7 @@ the validated shipping option #### Defined in -[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L366) +[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L366) ___ @@ -583,7 +583,7 @@ the validated price #### Defined in -[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L539) +[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L539) ___ @@ -608,7 +608,7 @@ a validated shipping requirement #### Defined in -[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L82) +[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-option.ts#L82) ___ @@ -632,4 +632,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ShippingProfileService.md b/docs/content/references/services/classes/ShippingProfileService.md index f0e4da3bb2..bd8508ae59 100644 --- a/docs/content/references/services/classes/ShippingProfileService.md +++ b/docs/content/references/services/classes/ShippingProfileService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L48) +[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L48) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L40) +[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L40) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L45) +[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L45) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L43) +[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L43) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L38) +[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L38) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L39) +[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L39) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L42) +[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L42) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L46) +[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L46) ## Methods @@ -160,7 +160,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-profile.ts:361](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L361) +[packages/medusa/src/services/shipping-profile.ts:361](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L361) ___ @@ -186,7 +186,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:381](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L381) +[packages/medusa/src/services/shipping-profile.ts:381](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L381) ___ @@ -225,7 +225,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -249,7 +249,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L250) +[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L250) ___ @@ -267,7 +267,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L180) +[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L180) ___ @@ -286,7 +286,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L224) +[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L224) ___ @@ -310,7 +310,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:335](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L335) +[packages/medusa/src/services/shipping-profile.ts:335](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L335) ___ @@ -335,7 +335,7 @@ a list of the available shipping options #### Defined in -[packages/medusa/src/services/shipping-profile.ts:401](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L401) +[packages/medusa/src/services/shipping-profile.ts:401](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L401) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L83) +[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L83) ___ @@ -380,7 +380,7 @@ a list of product ids #### Defined in -[packages/medusa/src/services/shipping-profile.ts:467](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L467) +[packages/medusa/src/services/shipping-profile.ts:467](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L467) ___ @@ -403,7 +403,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L71) +[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L71) ___ @@ -429,7 +429,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L135) +[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L135) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L164) +[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L164) ___ @@ -461,7 +461,7 @@ the shipping profile for gift cards #### Defined in -[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L207) +[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L207) ___ @@ -485,7 +485,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -512,7 +512,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:278](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L278) +[packages/medusa/src/services/shipping-profile.ts:278](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/shipping-profile.ts#L278) ___ @@ -536,4 +536,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/StoreService.md b/docs/content/references/services/classes/StoreService.md index a12709163f..e9a9201bd5 100644 --- a/docs/content/references/services/classes/StoreService.md +++ b/docs/content/references/services/classes/StoreService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L31) +[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L31) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L28) +[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L28) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L29) +[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L29) ___ @@ -88,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L24) +[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L24) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L27) +[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L27) ___ @@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L25) +[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L25) ## Methods @@ -136,7 +136,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L204) +[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L204) ___ @@ -175,7 +175,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -193,7 +193,7 @@ The store. #### Defined in -[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L49) +[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L49) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L98) +[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L98) ___ @@ -237,7 +237,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L248) +[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L248) ___ @@ -261,7 +261,7 @@ the store #### Defined in -[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L85) +[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L85) ___ @@ -285,7 +285,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -309,7 +309,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L114) +[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/store.ts#L114) ___ @@ -333,4 +333,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/StrategyResolverService.md b/docs/content/references/services/classes/StrategyResolverService.md index e2adc4be5c..ee70035f81 100644 --- a/docs/content/references/services/classes/StrategyResolverService.md +++ b/docs/content/references/services/classes/StrategyResolverService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/strategy-resolver.ts#L14) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/strategy-resolver.ts#L14) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/strategy-resolver.ts#L11) +[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/strategy-resolver.ts#L11) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/strategy-resolver.ts#L12) +[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/strategy-resolver.ts#L12) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/strategy-resolver.ts#L19) +[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/strategy-resolver.ts#L19) ___ @@ -173,7 +173,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -197,4 +197,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SwapService.md b/docs/content/references/services/classes/SwapService.md index 09e1a72af3..bed888a19b 100644 --- a/docs/content/references/services/classes/SwapService.md +++ b/docs/content/references/services/classes/SwapService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/swap.ts:93](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L93) +[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L94) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L80) +[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L80) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L91) +[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L90) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L81) +[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L81) ___ @@ -94,17 +94,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L87) - -___ - -### inventoryService\_ - -• `Protected` `Readonly` **inventoryService\_**: [`InventoryService`](InventoryService.md) - -#### Defined in - -[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L86) +[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L86) ___ @@ -114,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L90) +[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L89) ___ @@ -124,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L85) +[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L85) ___ @@ -138,7 +128,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L75) +[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L75) ___ @@ -148,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L82) +[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L82) ___ @@ -158,7 +148,17 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L89) +[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L88) + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md) + +#### Defined in + +[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L92) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L83) +[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L83) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L88) +[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L87) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L78) +[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L78) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L84) +[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L84) ___ @@ -212,7 +212,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L76) +[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L76) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L63) +[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L63) ## Methods @@ -275,7 +275,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -301,7 +301,7 @@ the canceled swap. #### Defined in -[packages/medusa/src/services/swap.ts:852](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L852) +[packages/medusa/src/services/swap.ts:841](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L841) ___ @@ -325,7 +325,7 @@ updated swap #### Defined in -[packages/medusa/src/services/swap.ts:1053](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1053) +[packages/medusa/src/services/swap.ts:1042](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L1042) ___ @@ -359,7 +359,7 @@ the newly created swap #### Defined in -[packages/medusa/src/services/swap.ts:314](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L314) +[packages/medusa/src/services/swap.ts:315](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L315) ___ @@ -387,7 +387,7 @@ the swap with its cart_id prop set to the id of the new cart. #### Defined in -[packages/medusa/src/services/swap.ts:563](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L563) +[packages/medusa/src/services/swap.ts:570](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L570) ___ @@ -413,7 +413,7 @@ the updated swap with new status and fulfillments. #### Defined in -[packages/medusa/src/services/swap.ts:914](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L914) +[packages/medusa/src/services/swap.ts:903](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L903) ___ @@ -440,7 +440,7 @@ the updated swap with new fulfillments and status. #### Defined in -[packages/medusa/src/services/swap.ts:1084](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1084) +[packages/medusa/src/services/swap.ts:1073](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L1073) ___ @@ -465,7 +465,7 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/swap.ts:1162](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1162) +[packages/medusa/src/services/swap.ts:1151](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L1151) ___ @@ -490,7 +490,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/swap.ts:284](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L284) +[packages/medusa/src/services/swap.ts:285](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L285) ___ @@ -514,7 +514,7 @@ processed swap #### Defined in -[packages/medusa/src/services/swap.ts:407](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L407) +[packages/medusa/src/services/swap.ts:414](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L414) ___ @@ -538,7 +538,7 @@ swap related to the cart #### Defined in -[packages/medusa/src/services/swap.ts:701](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L701) +[packages/medusa/src/services/swap.ts:708](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L708) ___ @@ -563,7 +563,7 @@ the resulting order #### Defined in -[packages/medusa/src/services/swap.ts:1202](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1202) +[packages/medusa/src/services/swap.ts:1191](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L1191) ___ @@ -588,7 +588,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:208](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L208) +[packages/medusa/src/services/swap.ts:209](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L209) ___ @@ -613,7 +613,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:257](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L257) +[packages/medusa/src/services/swap.ts:258](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L258) ___ @@ -637,7 +637,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -661,7 +661,7 @@ transformed find swap config #### Defined in -[packages/medusa/src/services/swap.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L135) +[packages/medusa/src/services/swap.ts:136](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L136) ___ @@ -686,7 +686,7 @@ updated swap record #### Defined in -[packages/medusa/src/services/swap.ts:530](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L530) +[packages/medusa/src/services/swap.ts:537](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/swap.ts#L537) ___ @@ -710,4 +710,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SystemPaymentProviderService.md b/docs/content/references/services/classes/SystemPaymentProviderService.md index 6a9178da25..7602d8db95 100644 --- a/docs/content/references/services/classes/SystemPaymentProviderService.md +++ b/docs/content/references/services/classes/SystemPaymentProviderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L10) +[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L10) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L5) +[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L5) ___ @@ -80,7 +80,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L6) +[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L6) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L8) +[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L8) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L26) +[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L26) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L50) +[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L50) ___ @@ -189,7 +189,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L42) +[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L42) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L14) +[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L14) ___ @@ -229,7 +229,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L38) +[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L38) ___ @@ -249,7 +249,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L22) +[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L22) ___ @@ -269,7 +269,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L18) +[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L18) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L46) +[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L46) ___ @@ -313,7 +313,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -333,7 +333,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L34) +[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L34) ___ @@ -353,7 +353,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/system-payment-provider.ts#L30) +[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/system-payment-provider.ts#L30) ___ @@ -377,4 +377,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/TaxProviderService.md b/docs/content/references/services/classes/TaxProviderService.md index adee44a88d..b941b2dd2b 100644 --- a/docs/content/references/services/classes/TaxProviderService.md +++ b/docs/content/references/services/classes/TaxProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L51) +[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L51) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L44) +[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L44) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L43) +[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L43) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L49) +[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L49) ___ @@ -98,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L40) +[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L40) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L47) +[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L47) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L46) +[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L46) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L48) +[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L48) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L45) +[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L45) ___ @@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L41) +[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L41) ## Methods @@ -191,7 +191,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -211,7 +211,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L97) +[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L97) ___ @@ -231,7 +231,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L107) +[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L107) ___ @@ -257,7 +257,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L183) +[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L183) ___ @@ -282,7 +282,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L129) +[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L129) ___ @@ -307,7 +307,7 @@ the cache key to use for the id set #### Defined in -[packages/medusa/src/services/tax-provider.ts:477](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L477) +[packages/medusa/src/services/tax-provider.ts:477](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L477) ___ @@ -333,7 +333,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:429](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L429) +[packages/medusa/src/services/tax-provider.ts:429](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L429) ___ @@ -359,7 +359,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:382](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L382) +[packages/medusa/src/services/tax-provider.ts:382](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L382) ___ @@ -386,7 +386,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L204) +[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L204) ___ @@ -415,7 +415,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L256) +[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L256) ___ @@ -438,7 +438,7 @@ Return a map of tax lines for line items and shipping methods #### Defined in -[packages/medusa/src/services/tax-provider.ts:345](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L345) +[packages/medusa/src/services/tax-provider.ts:345](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L345) ___ @@ -452,7 +452,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L65) +[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L65) ___ @@ -472,7 +472,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:481](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L481) +[packages/medusa/src/services/tax-provider.ts:481](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L481) ___ @@ -496,7 +496,7 @@ the region specific tax provider #### Defined in -[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L75) +[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-provider.ts#L75) ___ @@ -520,7 +520,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -544,4 +544,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/TaxRateService.md b/docs/content/references/services/classes/TaxRateService.md index a28bc7e24a..ead3a386b4 100644 --- a/docs/content/references/services/classes/TaxRateService.md +++ b/docs/content/references/services/classes/TaxRateService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L33) +[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L33) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L25) +[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L25) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L28) +[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L28) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L29) +[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L29) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L30) +[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L30) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L31) +[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L31) ___ @@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L26) +[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L26) ## Methods @@ -142,7 +142,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L190) +[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L190) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L226) +[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L226) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L266) +[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L266) ___ @@ -225,7 +225,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L97) +[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L97) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L128) +[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L128) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L49) +[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L49) ___ @@ -307,7 +307,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L60) +[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L60) ___ @@ -328,7 +328,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L314) +[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L314) ___ @@ -348,7 +348,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L324) +[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L324) ___ @@ -369,7 +369,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L136) +[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L136) ___ @@ -390,7 +390,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L154) +[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L154) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L172) +[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L172) ___ @@ -432,7 +432,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L71) +[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L71) ___ @@ -456,7 +456,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -477,7 +477,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L113) +[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/tax-rate.ts#L113) ___ @@ -501,4 +501,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/TokenService.md b/docs/content/references/services/classes/TokenService.md index a65981eddf..3e28087653 100644 --- a/docs/content/references/services/classes/TokenService.md +++ b/docs/content/references/services/classes/TokenService.md @@ -14,7 +14,7 @@ #### Defined in -[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L16) +[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/token.ts#L16) ## Properties @@ -24,7 +24,7 @@ #### Defined in -[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L14) +[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/token.ts#L14) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L12) +[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/token.ts#L12) ## Methods @@ -55,7 +55,7 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L34) +[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/token.ts#L34) ___ @@ -76,4 +76,4 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L20) +[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/token.ts#L20) diff --git a/docs/content/references/services/classes/TotalsService.md b/docs/content/references/services/classes/TotalsService.md index 31653268d5..416309c7f4 100644 --- a/docs/content/references/services/classes/TotalsService.md +++ b/docs/content/references/services/classes/TotalsService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/totals.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L116) +[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L113) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L114) +[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L111) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L108) +[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L105) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L112) +[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L109) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L113) +[packages/medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L110) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L111) +[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L108) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L109) +[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L106) ## Methods @@ -163,7 +163,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -191,7 +191,7 @@ triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:624](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L624) +[packages/medusa/src/services/totals.ts:621](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L621) ___ @@ -220,7 +220,7 @@ array of triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:666](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L666) +[packages/medusa/src/services/totals.ts:663](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L663) ___ @@ -251,7 +251,7 @@ the allocation map for the line items in the cart or order. #### Defined in -[packages/medusa/src/services/totals.ts:441](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L441) +[packages/medusa/src/services/totals.ts:438](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L438) ___ @@ -276,7 +276,7 @@ the tax calculation context #### Defined in -[packages/medusa/src/services/totals.ts:1028](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L1028) +[packages/medusa/src/services/totals.ts:1022](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L1022) ___ @@ -301,7 +301,7 @@ the total discounts amount #### Defined in -[packages/medusa/src/services/totals.ts:998](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L998) +[packages/medusa/src/services/totals.ts:992](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L992) ___ @@ -327,7 +327,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:964](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L964) +[packages/medusa/src/services/totals.ts:961](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L961) ___ @@ -352,7 +352,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:947](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L947) +[packages/medusa/src/services/totals.ts:944](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L944) ___ @@ -381,7 +381,7 @@ the allocations that the discount has on the items in the cart or #### Defined in -[packages/medusa/src/services/totals.ts:717](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L717) +[packages/medusa/src/services/totals.ts:714](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L714) ___ @@ -401,7 +401,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:694](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L694) +[packages/medusa/src/services/totals.ts:691](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L691) ___ @@ -422,7 +422,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:679](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L679) +[packages/medusa/src/services/totals.ts:676](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L676) ___ @@ -447,7 +447,7 @@ the line item refund amount. #### Defined in -[packages/medusa/src/services/totals.ts:502](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L502) +[packages/medusa/src/services/totals.ts:499](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L499) ___ @@ -474,7 +474,7 @@ the line item total #### Defined in -[packages/medusa/src/services/totals.ts:920](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L920) +[packages/medusa/src/services/totals.ts:917](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L917) ___ @@ -502,7 +502,7 @@ the breakdown of the line item totals #### Defined in -[packages/medusa/src/services/totals.ts:767](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L767) +[packages/medusa/src/services/totals.ts:764](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L764) ___ @@ -526,7 +526,7 @@ the total paid amount #### Defined in -[packages/medusa/src/services/totals.ts:163](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L163) +[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L160) ___ @@ -553,7 +553,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:581](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L581) +[packages/medusa/src/services/totals.ts:578](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L578) ___ @@ -577,7 +577,7 @@ the total refunded amount for an order. #### Defined in -[packages/medusa/src/services/totals.ts:487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L487) +[packages/medusa/src/services/totals.ts:484](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L484) ___ @@ -604,7 +604,7 @@ An object that breaks down the totals for the shipping method #### Defined in -[packages/medusa/src/services/totals.ts:197](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L197) +[packages/medusa/src/services/totals.ts:194](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L194) ___ @@ -628,7 +628,7 @@ shipping total #### Defined in -[packages/medusa/src/services/totals.ts:325](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L325) +[packages/medusa/src/services/totals.ts:322](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L322) ___ @@ -653,7 +653,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:289](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L289) +[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L286) ___ @@ -678,7 +678,7 @@ the swap total #### Defined in -[packages/medusa/src/services/totals.ts:178](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L178) +[packages/medusa/src/services/totals.ts:175](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L175) ___ @@ -704,7 +704,7 @@ tax total #### Defined in -[packages/medusa/src/services/totals.ts:352](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L352) +[packages/medusa/src/services/totals.ts:349](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L349) ___ @@ -729,7 +729,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:140](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L140) +[packages/medusa/src/services/totals.ts:137](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L137) ___ @@ -753,7 +753,7 @@ the rounded value #### Defined in -[packages/medusa/src/services/totals.ts:1058](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L1058) +[packages/medusa/src/services/totals.ts:1052](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/totals.ts#L1052) ___ @@ -777,7 +777,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -801,4 +801,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/UserService.md b/docs/content/references/services/classes/UserService.md index 7017fdf669..606db30483 100644 --- a/docs/content/references/services/classes/UserService.md +++ b/docs/content/references/services/classes/UserService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L47) +[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L42) +[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L42) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L44) +[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L44) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L45) +[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L45) ___ @@ -98,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L40) +[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L40) ___ @@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L41) +[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L41) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L43) +[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L43) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L33) +[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L33) ## Methods @@ -180,7 +180,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48) +[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48) ___ @@ -206,7 +206,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L179) +[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L179) ___ @@ -230,7 +230,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L259) +[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L259) ___ @@ -258,7 +258,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/user.ts:321](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L321) +[packages/medusa/src/services/user.ts:321](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L321) ___ @@ -282,7 +282,7 @@ hashed password #### Defined in -[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L167) +[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L167) ___ @@ -305,7 +305,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L69) +[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L69) ___ @@ -331,7 +331,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L82) +[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L82) ___ @@ -357,7 +357,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L113) +[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L113) ___ @@ -383,7 +383,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L142) +[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L142) ___ @@ -410,7 +410,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L292) +[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L292) ___ @@ -434,7 +434,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29) +[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29) ___ @@ -459,7 +459,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L213) +[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/user.ts#L213) ___ @@ -483,4 +483,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/index.md b/docs/content/references/services/index.md index 521d9dfee7..d29c12a237 100644 --- a/docs/content/references/services/index.md +++ b/docs/content/references/services/index.md @@ -21,7 +21,6 @@ - [FulfillmentService](classes/FulfillmentService.md) - [GiftCardService](classes/GiftCardService.md) - [IdempotencyKeyService](classes/IdempotencyKeyService.md) -- [InventoryService](classes/InventoryService.md) - [LineItemAdjustmentService](classes/LineItemAdjustmentService.md) - [LineItemService](classes/LineItemService.md) - [MiddlewareService](classes/MiddlewareService.md) @@ -37,13 +36,17 @@ - [PaymentService](classes/PaymentService.md) - [PriceListService](classes/PriceListService.md) - [PricingService](classes/PricingService.md) +- [ProductCategoryService](classes/ProductCategoryService.md) - [ProductCollectionService](classes/ProductCollectionService.md) - [ProductService](classes/ProductService.md) - [ProductTypeService](classes/ProductTypeService.md) +- [ProductVariantInventoryService](classes/ProductVariantInventoryService.md) - [ProductVariantService](classes/ProductVariantService.md) - [RegionService](classes/RegionService.md) - [ReturnReasonService](classes/ReturnReasonService.md) - [ReturnService](classes/ReturnService.md) +- [SalesChannelInventoryService](classes/SalesChannelInventoryService.md) +- [SalesChannelLocationService](classes/SalesChannelLocationService.md) - [SalesChannelService](classes/SalesChannelService.md) - [SearchService](classes/SearchService.md) - [ShippingOptionService](classes/ShippingOptionService.md) From f7e23afff22adc4222e2df5d1fabc7287b57b163 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 11 Jan 2023 18:08:33 +0200 Subject: [PATCH 02/14] chore(docs): Generated API Reference (#2994) Co-authored-by: olivermrbl --- docs/api/admin-spec3.json | 1213 +++++++++++++++++ docs/api/admin-spec3.yaml | 1213 +++++++++++++++++ .../product-categories/getundefined | 7 + .../product-categories/postundefined | 9 + .../product-categories_{id}/deleteundefined | 7 + .../product-categories_{id}/getundefined | 7 + .../deleteundefined | 9 + .../postundefined | 9 + .../JavaScript/stock-locations/getundefined | 7 + .../JavaScript/stock-locations/postundefined | 10 + .../stock-locations_{id}/getundefined | 7 + .../stock-locations_{id}/postundefined | 9 + .../Shell/product-categories/getundefined | 2 + .../Shell/product-categories/postundefined | 6 + .../product-categories_{id}/deleteundefined | 2 + .../product-categories_{id}/getundefined | 2 + .../deleteundefined | 6 + .../postundefined | 6 + .../Shell/stock-locations/getundefined | 2 + .../Shell/stock-locations/postundefined | 6 + .../Shell/stock-locations_{id}/getundefined | 2 + .../Shell/stock-locations_{id}/postundefined | 6 + ...SalesChannelsChannelStockLocationsReq.yaml | 7 + .../AdminPostProductCategoriesReq.yaml | 21 + ...SalesChannelsChannelStockLocationsReq.yaml | 7 + .../AdminPostStockLocationsLocationReq.yaml | 15 + .../schemas/AdminPostStockLocationsReq.yaml | 17 + .../schemas/CreateStockLocationInput.yaml | 22 + .../admin/components/schemas/Fulfillment.yaml | 4 + .../components/schemas/PaymentSession.yaml | 7 + .../components/schemas/ProductCategory.yaml | 56 + .../schemas/StockLocationAddressDTO.yaml | 58 + .../schemas/StockLocationAddressInput.yaml | 40 + .../components/schemas/StockLocationDTO.yaml | 44 + .../schemas/UpdateStockLocationInput.yaml | 20 + docs/api/admin/openapi.yaml | 10 + docs/api/admin/paths/product-categories.yaml | 146 ++ .../admin/paths/product-categories_{id}.yaml | 105 ++ .../sales-channels_{id}_stock-locations.yaml | 121 ++ docs/api/admin/paths/stock-locations.yaml | 217 +++ .../api/admin/paths/stock-locations_{id}.yaml | 109 ++ docs/api/store-spec3.json | 259 ++++ docs/api/store-spec3.yaml | 259 ++++ .../schemas/CreateStockLocationInput.yaml | 22 + .../store/components/schemas/Fulfillment.yaml | 4 + .../components/schemas/PaymentSession.yaml | 7 + .../components/schemas/ProductCategory.yaml | 56 + .../schemas/StockLocationAddressDTO.yaml | 58 + .../schemas/StockLocationAddressInput.yaml | 40 + .../components/schemas/StockLocationDTO.yaml | 44 + .../schemas/UpdateStockLocationInput.yaml | 20 + 51 files changed, 4342 insertions(+) create mode 100644 docs/api/admin/code_samples/JavaScript/product-categories/getundefined create mode 100644 docs/api/admin/code_samples/JavaScript/product-categories/postundefined create mode 100644 docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined create mode 100644 docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined create mode 100644 docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/deleteundefined create mode 100644 docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/postundefined create mode 100644 docs/api/admin/code_samples/JavaScript/stock-locations/getundefined create mode 100644 docs/api/admin/code_samples/JavaScript/stock-locations/postundefined create mode 100644 docs/api/admin/code_samples/JavaScript/stock-locations_{id}/getundefined create mode 100644 docs/api/admin/code_samples/JavaScript/stock-locations_{id}/postundefined create mode 100644 docs/api/admin/code_samples/Shell/product-categories/getundefined create mode 100644 docs/api/admin/code_samples/Shell/product-categories/postundefined create mode 100644 docs/api/admin/code_samples/Shell/product-categories_{id}/deleteundefined create mode 100644 docs/api/admin/code_samples/Shell/product-categories_{id}/getundefined create mode 100644 docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/deleteundefined create mode 100644 docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/postundefined create mode 100644 docs/api/admin/code_samples/Shell/stock-locations/getundefined create mode 100644 docs/api/admin/code_samples/Shell/stock-locations/postundefined create mode 100644 docs/api/admin/code_samples/Shell/stock-locations_{id}/getundefined create mode 100644 docs/api/admin/code_samples/Shell/stock-locations_{id}/postundefined create mode 100644 docs/api/admin/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml create mode 100644 docs/api/admin/components/schemas/AdminPostProductCategoriesReq.yaml create mode 100644 docs/api/admin/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml create mode 100644 docs/api/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml create mode 100644 docs/api/admin/components/schemas/AdminPostStockLocationsReq.yaml create mode 100644 docs/api/admin/components/schemas/CreateStockLocationInput.yaml create mode 100644 docs/api/admin/components/schemas/ProductCategory.yaml create mode 100644 docs/api/admin/components/schemas/StockLocationAddressDTO.yaml create mode 100644 docs/api/admin/components/schemas/StockLocationAddressInput.yaml create mode 100644 docs/api/admin/components/schemas/StockLocationDTO.yaml create mode 100644 docs/api/admin/components/schemas/UpdateStockLocationInput.yaml create mode 100644 docs/api/admin/paths/product-categories.yaml create mode 100644 docs/api/admin/paths/product-categories_{id}.yaml create mode 100644 docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml create mode 100644 docs/api/admin/paths/stock-locations.yaml create mode 100644 docs/api/admin/paths/stock-locations_{id}.yaml create mode 100644 docs/api/store/components/schemas/CreateStockLocationInput.yaml create mode 100644 docs/api/store/components/schemas/ProductCategory.yaml create mode 100644 docs/api/store/components/schemas/StockLocationAddressDTO.yaml create mode 100644 docs/api/store/components/schemas/StockLocationAddressInput.yaml create mode 100644 docs/api/store/components/schemas/StockLocationDTO.yaml create mode 100644 docs/api/store/components/schemas/UpdateStockLocationInput.yaml diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index 3a591aca54..e03ef39e05 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -10616,6 +10616,325 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /product-categories: + post: + operationId: PostProductCategories + summary: Create a Product Category + description: Creates a Product Category. + x-authenticated: true + parameters: + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be retrieved in each product + category. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.create({ + name: 'Jeans', + }) + + .then(({ productCategory }) => { + console.log(productCategory.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "Jeans", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + productCategory: + $ref: '#/components/schemas/ProductCategory' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: true + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: is_internal + description: Search for only internal categories. + schema: + type: boolean + - in: query + name: is_active + description: Search for only active categories + schema: + type: boolean + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.list() + + .then(({ product_category, limit, offset, count }) => { + console.log(product_category.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + product_category: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/product-categories/{id}': + delete: + operationId: DeleteProductCategoriesCategory + summary: Delete a Product Category + description: Deletes a ProductCategory. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.delete(product_category_id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the deleted product category. + object: + type: string + description: The type of the object that was deleted. + default: product_category + deleted: + type: boolean + description: >- + Whether the product category was deleted successfully or + not. + default: true + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.retrieve("pcat-id") + + .then(({ productCategory }) => { + console.log(productCategory.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + productCategory: + $ref: '#/components/schemas/ProductCategory' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /product-tags: get: operationId: GetProductTags @@ -14593,6 +14912,168 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/sales-channels/{id}/stock-locations': + post: + operationId: PostSalesChannelsSalesChannelStockLocation + summary: Associate a stock location to a Sales Channel + description: Associates a stock location to a Sales Channel. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Sales Channel. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.salesChannels.addLocation(sales_channel_id, { + location_id: 'App' + }) + + .then(({ sales_channel }) => { + console.log(sales_channel.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "locaton_id": "stock_location_id" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + sales_channel: + $ref: '#/components/schemas/SalesChannel' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteSalesChannelsSalesChannelStockLocation + summary: Remove a stock location from a Sales Channel + description: Removes a stock location from a Sales Channel. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Sales Channel. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.salesChannels.removeLocation(sales_channel_id, { + location_id: 'App' + }) + + .then(({ sales_channel }) => { + console.log(sales_channel.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "locaton_id": "stock_location_id" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the removed stock location from a sales channel + object: + type: string + description: The type of the object that was removed. + default: stock-location + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /sales-channels: post: operationId: PostSalesChannels @@ -15765,6 +16246,407 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /stock-locations: + post: + operationId: PostStockLocations + summary: Create a Stock Location + description: Creates a Stock Location. + x-authenticated: true + parameters: + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostStockLocationsReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.create({ + name: 'Main Warehouse', + location_id: 'sloc' + }) + + .then(({ stock_location }) => { + console.log(stock_location.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "App" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: '#/components/schemas/StockLocationDTO' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + get: + operationId: GetStockLocations + summary: List Stock Locations + description: Retrieves a list of stock locations + x-authenticated: true + parameters: + - in: query + name: id + description: ID of the stock location + schema: + type: string + - in: query + name: name + description: Name of the stock location + schema: + type: string + - in: query + name: order + description: The field to order the results by. + schema: + type: string + - in: query + name: created_at + description: Date comparison for when resulting collections were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting collections were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: deleted_at + description: Date comparison for when resulting collections were deleted. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: offset + description: How many stock locations to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of stock locations returned. + schema: + type: integer + default: 20 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each stock + location of the result. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in each stock + location of the result. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.list() + + .then(({ stock_locations, limit, offset, count }) => { + console.log(stock_locations.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_locations: + type: array + items: + $ref: '#/components/schemas/StockLocationDTO' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/stock-locations/{id}': + get: + operationId: GetStockLocationsStockLocation + summary: Get a Stock Location + description: Retrieves the Stock Location. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Stock Location. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.retrieve(stock_location_id) + + .then(({ stock_location }) => { + console.log(stock_location.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/stock-locations/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: '#/components/schemas/StockLocationDTO' + post: + operationId: PostStockLocationsStockLocation + summary: Update a Stock Location + description: Updates a Stock Location. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Stock Location. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostStockLocationsLocationReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.update(stock_location_id, { + name: 'App' + }) + + .then(({ stock_location }) => { + console.log(stock_location.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/stock-locations/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "App" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: '#/components/schemas/StockLocationDTO' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' '/store/currencies/{code}': post: operationId: PostStoreCurrenciesCode @@ -20157,6 +21039,10 @@ components: fulfillment type: string example: manual + location_id: + description: The id of the stock location the fulfillment will be shipped from + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. $ref: '#/components/schemas/FulfillmentProvider' @@ -21698,6 +22584,13 @@ components: method that will be used to complete the purchase. type: boolean example: true + is_initiated: + description: >- + A flag to indicate if a communication with the third party provider + has been initiated. + type: boolean + example: true + default: false status: description: >- Indicates the status of the Payment Session. Will default to @@ -21912,6 +22805,65 @@ components: type: string description: The date with timezone at which the resource was deleted. format: date-time + ProductCategory: + title: ProductCategory + description: Represents a product category + x-resourceId: ProductCategory + type: object + required: + - name + properties: + id: + type: string + description: The product category's ID + example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 + name: + type: string + description: The product category's name + example: Regular Fit + handle: + description: >- + A unique string that identifies the Category - example: slug + structures. + type: string + example: regular-fit + mpath: + type: string + description: >- + A string for Materialized Paths - used for finding ancestors and + descendents + example: pcat_id1.pcat_id2.pcat_id3 + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + default: false + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + default: false + category_children: + description: Available if the relation `category_children` are expanded. + type: array + items: + type: object + description: A product category object. + parent_category: + description: >- + A product category object. Available if the relation + `parent_category` is expanded. + type: object + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. @@ -23927,6 +24879,195 @@ components: description: An optional key-value map with additional details example: car: white + StockLocationAddressDTO: + title: Stock Location Address + description: Represents a Stock Location Address + type: object + required: + - address_1 + - country_code + - created_at + - updated_at + properties: + id: + type: string + description: The stock location address' ID + example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + StockLocationDTO: + title: Stock Location + description: Represents a Stock Location + type: object + required: + - id + - name + - address_id + - created_at + - updated_at + properties: + id: + type: string + description: The stock location's ID + example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 + address_id: + type: string + description: Stock location address' ID + example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 + name: + type: string + description: The name of the stock location + example: Main Warehouse + address: + description: The Address of the Stock Location + allOf: + - $ref: '#/components/schemas/StockLocationAddressDTO' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + StockLocationAddressInput: + title: Stock Location Address Input + description: Represents a Stock Location Address Input + type: object + required: + - address_1 + - country_code + properties: + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + CreateStockLocationInput: + title: Create Stock Location Input + description: Represents the Input to create a Stock Location + type: object + required: + - name + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + UpdateStockLocationInput: + title: Update Stock Location Input + description: Represents the Input to update a Stock Location + type: object + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white MultipleErrors: title: Multiple Errors type: object @@ -25603,6 +26744,28 @@ components: includes_tax: description: '[EXPERIMENTAL] Tax included in prices of price list' type: boolean + AdminPostProductCategoriesReq: + type: object + required: + - name + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: >- + An optional handle to be used in slugs, if none is provided we will + kebab-case the title. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category AdminPostProductsProductOptionsReq: type: object required: @@ -26533,6 +27696,14 @@ components: id: type: string description: The ID of the product + AdminPostSalesChannelsChannelStockLocationsReq: + type: object + required: + - location_id + properties: + location_id: + description: The ID of the stock location + type: string AdminPostSalesChannelsReq: type: object required: @@ -26563,6 +27734,14 @@ components: id: description: The ID of a product type: string + AdminDeleteSalesChannelsChannelStockLocationsReq: + type: object + required: + - location_id + properties: + location_id: + description: The ID of the stock location + type: string AdminPostSalesChannelsSalesChannelReq: type: object properties: @@ -26699,6 +27878,40 @@ components: name: description: The name of the Shipping Profile type: string + AdminPostStockLocationsReq: + type: object + required: + - name + properties: + name: + description: the name of the stock location + type: string + address_id: + description: the stock location address ID + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + address: + $ref: '#/components/schemas/StockLocationAddressInput' + AdminPostStockLocationsLocationReq: + type: object + properties: + name: + description: the name of the stock location + type: string + address_id: + description: the stock location address ID + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + address: + $ref: '#/components/schemas/StockLocationAddressInput' AdminPostStoreReq: type: object properties: diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index 3a591aca54..e03ef39e05 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -10616,6 +10616,325 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /product-categories: + post: + operationId: PostProductCategories + summary: Create a Product Category + description: Creates a Product Category. + x-authenticated: true + parameters: + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be retrieved in each product + category. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.create({ + name: 'Jeans', + }) + + .then(({ productCategory }) => { + console.log(productCategory.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "Jeans", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + productCategory: + $ref: '#/components/schemas/ProductCategory' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: true + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: is_internal + description: Search for only internal categories. + schema: + type: boolean + - in: query + name: is_active + description: Search for only active categories + schema: + type: boolean + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.list() + + .then(({ product_category, limit, offset, count }) => { + console.log(product_category.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + product_category: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/product-categories/{id}': + delete: + operationId: DeleteProductCategoriesCategory + summary: Delete a Product Category + description: Deletes a ProductCategory. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.delete(product_category_id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the deleted product category. + object: + type: string + description: The type of the object that was deleted. + default: product_category + deleted: + type: boolean + description: >- + Whether the product category was deleted successfully or + not. + default: true + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.retrieve("pcat-id") + + .then(({ productCategory }) => { + console.log(productCategory.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + productCategory: + $ref: '#/components/schemas/ProductCategory' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /product-tags: get: operationId: GetProductTags @@ -14593,6 +14912,168 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/sales-channels/{id}/stock-locations': + post: + operationId: PostSalesChannelsSalesChannelStockLocation + summary: Associate a stock location to a Sales Channel + description: Associates a stock location to a Sales Channel. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Sales Channel. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.salesChannels.addLocation(sales_channel_id, { + location_id: 'App' + }) + + .then(({ sales_channel }) => { + console.log(sales_channel.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "locaton_id": "stock_location_id" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + sales_channel: + $ref: '#/components/schemas/SalesChannel' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteSalesChannelsSalesChannelStockLocation + summary: Remove a stock location from a Sales Channel + description: Removes a stock location from a Sales Channel. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Sales Channel. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.salesChannels.removeLocation(sales_channel_id, { + location_id: 'App' + }) + + .then(({ sales_channel }) => { + console.log(sales_channel.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "locaton_id": "stock_location_id" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the removed stock location from a sales channel + object: + type: string + description: The type of the object that was removed. + default: stock-location + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /sales-channels: post: operationId: PostSalesChannels @@ -15765,6 +16246,407 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /stock-locations: + post: + operationId: PostStockLocations + summary: Create a Stock Location + description: Creates a Stock Location. + x-authenticated: true + parameters: + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostStockLocationsReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.create({ + name: 'Main Warehouse', + location_id: 'sloc' + }) + + .then(({ stock_location }) => { + console.log(stock_location.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "App" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: '#/components/schemas/StockLocationDTO' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + get: + operationId: GetStockLocations + summary: List Stock Locations + description: Retrieves a list of stock locations + x-authenticated: true + parameters: + - in: query + name: id + description: ID of the stock location + schema: + type: string + - in: query + name: name + description: Name of the stock location + schema: + type: string + - in: query + name: order + description: The field to order the results by. + schema: + type: string + - in: query + name: created_at + description: Date comparison for when resulting collections were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting collections were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: deleted_at + description: Date comparison for when resulting collections were deleted. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: offset + description: How many stock locations to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of stock locations returned. + schema: + type: integer + default: 20 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each stock + location of the result. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in each stock + location of the result. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.list() + + .then(({ stock_locations, limit, offset, count }) => { + console.log(stock_locations.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/stock-locations' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_locations: + type: array + items: + $ref: '#/components/schemas/StockLocationDTO' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/stock-locations/{id}': + get: + operationId: GetStockLocationsStockLocation + summary: Get a Stock Location + description: Retrieves the Stock Location. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Stock Location. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.retrieve(stock_location_id) + + .then(({ stock_location }) => { + console.log(stock_location.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/stock-locations/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: '#/components/schemas/StockLocationDTO' + post: + operationId: PostStockLocationsStockLocation + summary: Update a Stock Location + description: Updates a Stock Location. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Stock Location. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostStockLocationsLocationReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.stockLocations.update(stock_location_id, { + name: 'App' + }) + + .then(({ stock_location }) => { + console.log(stock_location.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/stock-locations/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "App" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: '#/components/schemas/StockLocationDTO' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' '/store/currencies/{code}': post: operationId: PostStoreCurrenciesCode @@ -20157,6 +21039,10 @@ components: fulfillment type: string example: manual + location_id: + description: The id of the stock location the fulfillment will be shipped from + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. $ref: '#/components/schemas/FulfillmentProvider' @@ -21698,6 +22584,13 @@ components: method that will be used to complete the purchase. type: boolean example: true + is_initiated: + description: >- + A flag to indicate if a communication with the third party provider + has been initiated. + type: boolean + example: true + default: false status: description: >- Indicates the status of the Payment Session. Will default to @@ -21912,6 +22805,65 @@ components: type: string description: The date with timezone at which the resource was deleted. format: date-time + ProductCategory: + title: ProductCategory + description: Represents a product category + x-resourceId: ProductCategory + type: object + required: + - name + properties: + id: + type: string + description: The product category's ID + example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 + name: + type: string + description: The product category's name + example: Regular Fit + handle: + description: >- + A unique string that identifies the Category - example: slug + structures. + type: string + example: regular-fit + mpath: + type: string + description: >- + A string for Materialized Paths - used for finding ancestors and + descendents + example: pcat_id1.pcat_id2.pcat_id3 + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + default: false + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + default: false + category_children: + description: Available if the relation `category_children` are expanded. + type: array + items: + type: object + description: A product category object. + parent_category: + description: >- + A product category object. Available if the relation + `parent_category` is expanded. + type: object + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. @@ -23927,6 +24879,195 @@ components: description: An optional key-value map with additional details example: car: white + StockLocationAddressDTO: + title: Stock Location Address + description: Represents a Stock Location Address + type: object + required: + - address_1 + - country_code + - created_at + - updated_at + properties: + id: + type: string + description: The stock location address' ID + example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + StockLocationDTO: + title: Stock Location + description: Represents a Stock Location + type: object + required: + - id + - name + - address_id + - created_at + - updated_at + properties: + id: + type: string + description: The stock location's ID + example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 + address_id: + type: string + description: Stock location address' ID + example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 + name: + type: string + description: The name of the stock location + example: Main Warehouse + address: + description: The Address of the Stock Location + allOf: + - $ref: '#/components/schemas/StockLocationAddressDTO' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + StockLocationAddressInput: + title: Stock Location Address Input + description: Represents a Stock Location Address Input + type: object + required: + - address_1 + - country_code + properties: + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + CreateStockLocationInput: + title: Create Stock Location Input + description: Represents the Input to create a Stock Location + type: object + required: + - name + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + UpdateStockLocationInput: + title: Update Stock Location Input + description: Represents the Input to update a Stock Location + type: object + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white MultipleErrors: title: Multiple Errors type: object @@ -25603,6 +26744,28 @@ components: includes_tax: description: '[EXPERIMENTAL] Tax included in prices of price list' type: boolean + AdminPostProductCategoriesReq: + type: object + required: + - name + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: >- + An optional handle to be used in slugs, if none is provided we will + kebab-case the title. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category AdminPostProductsProductOptionsReq: type: object required: @@ -26533,6 +27696,14 @@ components: id: type: string description: The ID of the product + AdminPostSalesChannelsChannelStockLocationsReq: + type: object + required: + - location_id + properties: + location_id: + description: The ID of the stock location + type: string AdminPostSalesChannelsReq: type: object required: @@ -26563,6 +27734,14 @@ components: id: description: The ID of a product type: string + AdminDeleteSalesChannelsChannelStockLocationsReq: + type: object + required: + - location_id + properties: + location_id: + description: The ID of the stock location + type: string AdminPostSalesChannelsSalesChannelReq: type: object properties: @@ -26699,6 +27878,40 @@ components: name: description: The name of the Shipping Profile type: string + AdminPostStockLocationsReq: + type: object + required: + - name + properties: + name: + description: the name of the stock location + type: string + address_id: + description: the stock location address ID + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + address: + $ref: '#/components/schemas/StockLocationAddressInput' + AdminPostStockLocationsLocationReq: + type: object + properties: + name: + description: the name of the stock location + type: string + address_id: + description: the stock location address ID + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + address: + $ref: '#/components/schemas/StockLocationAddressInput' AdminPostStoreReq: type: object properties: diff --git a/docs/api/admin/code_samples/JavaScript/product-categories/getundefined b/docs/api/admin/code_samples/JavaScript/product-categories/getundefined new file mode 100644 index 0000000000..328cf218a4 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/product-categories/getundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.productCategories.list() +.then(({ product_category, limit, offset, count }) => { + console.log(product_category.length); +}); diff --git a/docs/api/admin/code_samples/JavaScript/product-categories/postundefined b/docs/api/admin/code_samples/JavaScript/product-categories/postundefined new file mode 100644 index 0000000000..cd4b7f79e6 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/product-categories/postundefined @@ -0,0 +1,9 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.productCategories.create({ + name: 'Jeans', +}) +.then(({ productCategory }) => { + console.log(productCategory.id); +}); diff --git a/docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined b/docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined new file mode 100644 index 0000000000..3f79a9da46 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.productCategories.delete(product_category_id) +.then(({ id, object, deleted }) => { + console.log(id); +}); diff --git a/docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined b/docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined new file mode 100644 index 0000000000..9956745cd5 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.productCategories.retrieve("pcat-id") +.then(({ productCategory }) => { + console.log(productCategory.id); +}); diff --git a/docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/deleteundefined b/docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/deleteundefined new file mode 100644 index 0000000000..b844ab0556 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/deleteundefined @@ -0,0 +1,9 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.salesChannels.removeLocation(sales_channel_id, { + location_id: 'App' +}) +.then(({ sales_channel }) => { + console.log(sales_channel.id); +}); diff --git a/docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/postundefined b/docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/postundefined new file mode 100644 index 0000000000..e7f6ce2ec5 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/sales-channels_{id}_stock-locations/postundefined @@ -0,0 +1,9 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.salesChannels.addLocation(sales_channel_id, { + location_id: 'App' +}) +.then(({ sales_channel }) => { + console.log(sales_channel.id); +}); diff --git a/docs/api/admin/code_samples/JavaScript/stock-locations/getundefined b/docs/api/admin/code_samples/JavaScript/stock-locations/getundefined new file mode 100644 index 0000000000..b0af38afae --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/stock-locations/getundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.stockLocations.list() +.then(({ stock_locations, limit, offset, count }) => { + console.log(stock_locations.length); +}); diff --git a/docs/api/admin/code_samples/JavaScript/stock-locations/postundefined b/docs/api/admin/code_samples/JavaScript/stock-locations/postundefined new file mode 100644 index 0000000000..9086456b5a --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/stock-locations/postundefined @@ -0,0 +1,10 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.stockLocations.create({ + name: 'Main Warehouse', + location_id: 'sloc' +}) +.then(({ stock_location }) => { + console.log(stock_location.id); +}); diff --git a/docs/api/admin/code_samples/JavaScript/stock-locations_{id}/getundefined b/docs/api/admin/code_samples/JavaScript/stock-locations_{id}/getundefined new file mode 100644 index 0000000000..166e58a981 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/stock-locations_{id}/getundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.stockLocations.retrieve(stock_location_id) +.then(({ stock_location }) => { + console.log(stock_location.id); +}); diff --git a/docs/api/admin/code_samples/JavaScript/stock-locations_{id}/postundefined b/docs/api/admin/code_samples/JavaScript/stock-locations_{id}/postundefined new file mode 100644 index 0000000000..50563ddc97 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/stock-locations_{id}/postundefined @@ -0,0 +1,9 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.stockLocations.update(stock_location_id, { + name: 'App' +}) +.then(({ stock_location }) => { + console.log(stock_location.id); +}); diff --git a/docs/api/admin/code_samples/Shell/product-categories/getundefined b/docs/api/admin/code_samples/Shell/product-categories/getundefined new file mode 100644 index 0000000000..babbcf3733 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/product-categories/getundefined @@ -0,0 +1,2 @@ +curl --location --request GET 'https://medusa-url.com/admin/product-categories' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/product-categories/postundefined b/docs/api/admin/code_samples/Shell/product-categories/postundefined new file mode 100644 index 0000000000..1c747603c7 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/product-categories/postundefined @@ -0,0 +1,6 @@ +curl --location --request POST 'https://medusa-url.com/admin/product-categories' \ +--header 'Authorization: Bearer {api_token}' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "name": "Jeans", +}' diff --git a/docs/api/admin/code_samples/Shell/product-categories_{id}/deleteundefined b/docs/api/admin/code_samples/Shell/product-categories_{id}/deleteundefined new file mode 100644 index 0000000000..be401c78c2 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/product-categories_{id}/deleteundefined @@ -0,0 +1,2 @@ +curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/product-categories_{id}/getundefined b/docs/api/admin/code_samples/Shell/product-categories_{id}/getundefined new file mode 100644 index 0000000000..b25a813f59 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/product-categories_{id}/getundefined @@ -0,0 +1,2 @@ +curl --location --request GET 'https://medusa-url.com/admin/product-categories/{id}' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/deleteundefined b/docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/deleteundefined new file mode 100644 index 0000000000..08fc0f518a --- /dev/null +++ b/docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/deleteundefined @@ -0,0 +1,6 @@ +curl --location --request DELETE 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \ +--header 'Authorization: Bearer {api_token}' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "locaton_id": "stock_location_id" +}' diff --git a/docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/postundefined b/docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/postundefined new file mode 100644 index 0000000000..55c2aaabfc --- /dev/null +++ b/docs/api/admin/code_samples/Shell/sales-channels_{id}_stock-locations/postundefined @@ -0,0 +1,6 @@ +curl --location --request POST 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \ +--header 'Authorization: Bearer {api_token}' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "locaton_id": "stock_location_id" +}' diff --git a/docs/api/admin/code_samples/Shell/stock-locations/getundefined b/docs/api/admin/code_samples/Shell/stock-locations/getundefined new file mode 100644 index 0000000000..f9f88ce530 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/stock-locations/getundefined @@ -0,0 +1,2 @@ +curl --location --request GET 'https://medusa-url.com/admin/stock-locations' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/stock-locations/postundefined b/docs/api/admin/code_samples/Shell/stock-locations/postundefined new file mode 100644 index 0000000000..4445fed6bb --- /dev/null +++ b/docs/api/admin/code_samples/Shell/stock-locations/postundefined @@ -0,0 +1,6 @@ +curl --location --request POST 'https://medusa-url.com/admin/stock-locations' \ +--header 'Authorization: Bearer {api_token}' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "name": "App" +}' diff --git a/docs/api/admin/code_samples/Shell/stock-locations_{id}/getundefined b/docs/api/admin/code_samples/Shell/stock-locations_{id}/getundefined new file mode 100644 index 0000000000..ec108c3a5b --- /dev/null +++ b/docs/api/admin/code_samples/Shell/stock-locations_{id}/getundefined @@ -0,0 +1,2 @@ +curl --location --request GET 'https://medusa-url.com/admin/stock-locations/{id}' \ +--header 'Authorization: Bearer {api_token}' \ diff --git a/docs/api/admin/code_samples/Shell/stock-locations_{id}/postundefined b/docs/api/admin/code_samples/Shell/stock-locations_{id}/postundefined new file mode 100644 index 0000000000..b0130c506d --- /dev/null +++ b/docs/api/admin/code_samples/Shell/stock-locations_{id}/postundefined @@ -0,0 +1,6 @@ +curl --location --request POST 'https://medusa-url.com/admin/stock-locations/{id}' \ +--header 'Authorization: Bearer {api_token}' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "name": "App" +}' diff --git a/docs/api/admin/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml b/docs/api/admin/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml new file mode 100644 index 0000000000..a62aecc7e0 --- /dev/null +++ b/docs/api/admin/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml @@ -0,0 +1,7 @@ +type: object +required: + - location_id +properties: + location_id: + description: The ID of the stock location + type: string diff --git a/docs/api/admin/components/schemas/AdminPostProductCategoriesReq.yaml b/docs/api/admin/components/schemas/AdminPostProductCategoriesReq.yaml new file mode 100644 index 0000000000..ce349dde14 --- /dev/null +++ b/docs/api/admin/components/schemas/AdminPostProductCategoriesReq.yaml @@ -0,0 +1,21 @@ +type: object +required: + - name +properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: >- + An optional handle to be used in slugs, if none is provided we will + kebab-case the title. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category diff --git a/docs/api/admin/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml b/docs/api/admin/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml new file mode 100644 index 0000000000..a62aecc7e0 --- /dev/null +++ b/docs/api/admin/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml @@ -0,0 +1,7 @@ +type: object +required: + - location_id +properties: + location_id: + description: The ID of the stock location + type: string diff --git a/docs/api/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml b/docs/api/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml new file mode 100644 index 0000000000..94bc44d6d2 --- /dev/null +++ b/docs/api/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml @@ -0,0 +1,15 @@ +type: object +properties: + name: + description: the name of the stock location + type: string + address_id: + description: the stock location address ID + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + address: + $ref: ./StockLocationAddressInput.yaml diff --git a/docs/api/admin/components/schemas/AdminPostStockLocationsReq.yaml b/docs/api/admin/components/schemas/AdminPostStockLocationsReq.yaml new file mode 100644 index 0000000000..7507b09127 --- /dev/null +++ b/docs/api/admin/components/schemas/AdminPostStockLocationsReq.yaml @@ -0,0 +1,17 @@ +type: object +required: + - name +properties: + name: + description: the name of the stock location + type: string + address_id: + description: the stock location address ID + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + address: + $ref: ./StockLocationAddressInput.yaml diff --git a/docs/api/admin/components/schemas/CreateStockLocationInput.yaml b/docs/api/admin/components/schemas/CreateStockLocationInput.yaml new file mode 100644 index 0000000000..6a8d7255f5 --- /dev/null +++ b/docs/api/admin/components/schemas/CreateStockLocationInput.yaml @@ -0,0 +1,22 @@ +title: Create Stock Location Input +description: Represents the Input to create a Stock Location +type: object +required: + - name +properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: ./StockLocationAddressInput.yaml + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/admin/components/schemas/Fulfillment.yaml b/docs/api/admin/components/schemas/Fulfillment.yaml index 0c34d6607b..8567463bfe 100644 --- a/docs/api/admin/components/schemas/Fulfillment.yaml +++ b/docs/api/admin/components/schemas/Fulfillment.yaml @@ -42,6 +42,10 @@ properties: fulfillment type: string example: manual + location_id: + description: The id of the stock location the fulfillment will be shipped from + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. $ref: ./FulfillmentProvider.yaml diff --git a/docs/api/admin/components/schemas/PaymentSession.yaml b/docs/api/admin/components/schemas/PaymentSession.yaml index 3d7e87862b..440d532f58 100644 --- a/docs/api/admin/components/schemas/PaymentSession.yaml +++ b/docs/api/admin/components/schemas/PaymentSession.yaml @@ -33,6 +33,13 @@ properties: that will be used to complete the purchase. type: boolean example: true + is_initiated: + description: >- + A flag to indicate if a communication with the third party provider has + been initiated. + type: boolean + example: true + default: false status: description: >- Indicates the status of the Payment Session. Will default to `pending`, diff --git a/docs/api/admin/components/schemas/ProductCategory.yaml b/docs/api/admin/components/schemas/ProductCategory.yaml new file mode 100644 index 0000000000..135a745936 --- /dev/null +++ b/docs/api/admin/components/schemas/ProductCategory.yaml @@ -0,0 +1,56 @@ +title: ProductCategory +description: Represents a product category +x-resourceId: ProductCategory +type: object +required: + - name +properties: + id: + type: string + description: The product category's ID + example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 + name: + type: string + description: The product category's name + example: Regular Fit + handle: + description: 'A unique string that identifies the Category - example: slug structures.' + type: string + example: regular-fit + mpath: + type: string + description: >- + A string for Materialized Paths - used for finding ancestors and + descendents + example: pcat_id1.pcat_id2.pcat_id3 + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + default: false + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + default: false + category_children: + description: Available if the relation `category_children` are expanded. + type: array + items: + type: object + description: A product category object. + parent_category: + description: >- + A product category object. Available if the relation `parent_category` is + expanded. + type: object + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time diff --git a/docs/api/admin/components/schemas/StockLocationAddressDTO.yaml b/docs/api/admin/components/schemas/StockLocationAddressDTO.yaml new file mode 100644 index 0000000000..de9461efb2 --- /dev/null +++ b/docs/api/admin/components/schemas/StockLocationAddressDTO.yaml @@ -0,0 +1,58 @@ +title: Stock Location Address +description: Represents a Stock Location Address +type: object +required: + - address_1 + - country_code + - created_at + - updated_at +properties: + id: + type: string + description: The stock location address' ID + example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 + address_1: + type: string + description: Stock location address + example: 35, Jhon Doe Ave + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/admin/components/schemas/StockLocationAddressInput.yaml b/docs/api/admin/components/schemas/StockLocationAddressInput.yaml new file mode 100644 index 0000000000..700d86deb8 --- /dev/null +++ b/docs/api/admin/components/schemas/StockLocationAddressInput.yaml @@ -0,0 +1,40 @@ +title: Stock Location Address Input +description: Represents a Stock Location Address Input +type: object +required: + - address_1 + - country_code +properties: + address_1: + type: string + description: Stock location address + example: 35, Jhon Doe Ave + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/admin/components/schemas/StockLocationDTO.yaml b/docs/api/admin/components/schemas/StockLocationDTO.yaml new file mode 100644 index 0000000000..e4233fd30d --- /dev/null +++ b/docs/api/admin/components/schemas/StockLocationDTO.yaml @@ -0,0 +1,44 @@ +title: Stock Location +description: Represents a Stock Location +type: object +required: + - id + - name + - address_id + - created_at + - updated_at +properties: + id: + type: string + description: The stock location's ID + example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 + address_id: + type: string + description: Stock location address' ID + example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 + name: + type: string + description: The name of the stock location + example: Main Warehouse + address: + description: The Address of the Stock Location + allOf: + - $ref: ./StockLocationAddressDTO.yaml + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time diff --git a/docs/api/admin/components/schemas/UpdateStockLocationInput.yaml b/docs/api/admin/components/schemas/UpdateStockLocationInput.yaml new file mode 100644 index 0000000000..6b14b20a0e --- /dev/null +++ b/docs/api/admin/components/schemas/UpdateStockLocationInput.yaml @@ -0,0 +1,20 @@ +title: Update Stock Location Input +description: Represents the Input to update a Stock Location +type: object +properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: ./StockLocationAddressInput.yaml + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/admin/openapi.yaml b/docs/api/admin/openapi.yaml index 7f8928e73c..f206186be9 100644 --- a/docs/api/admin/openapi.yaml +++ b/docs/api/admin/openapi.yaml @@ -347,6 +347,10 @@ paths: $ref: paths/price-lists_{id}_variants_{variant_id}_prices.yaml /price-lists/{id}/products: $ref: paths/price-lists_{id}_products.yaml + /product-categories: + $ref: paths/product-categories.yaml + /product-categories/{id}: + $ref: paths/product-categories_{id}.yaml /product-tags: $ref: paths/product-tags.yaml /product-types: @@ -411,6 +415,8 @@ paths: $ref: paths/returns_{id}_receive.yaml /sales-channels/{id}/products/batch: $ref: paths/sales-channels_{id}_products_batch.yaml + /sales-channels/{id}/stock-locations: + $ref: paths/sales-channels_{id}_stock-locations.yaml /sales-channels: $ref: paths/sales-channels.yaml /sales-channels/{id}: @@ -423,6 +429,10 @@ paths: $ref: paths/shipping-profiles.yaml /shipping-profiles/{id}: $ref: paths/shipping-profiles_{id}.yaml + /stock-locations: + $ref: paths/stock-locations.yaml + /stock-locations/{id}: + $ref: paths/stock-locations_{id}.yaml /store/currencies/{code}: $ref: paths/store_currencies_{code}.yaml /store: diff --git a/docs/api/admin/paths/product-categories.yaml b/docs/api/admin/paths/product-categories.yaml new file mode 100644 index 0000000000..1510953bf8 --- /dev/null +++ b/docs/api/admin/paths/product-categories.yaml @@ -0,0 +1,146 @@ +post: + operationId: PostProductCategories + summary: Create a Product Category + description: Creates a Product Category. + x-authenticated: true + parameters: + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be retrieved in each product + category. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostProductCategoriesReq.yaml + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/product-categories/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/product-categories/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + productCategory: + $ref: ../components/schemas/ProductCategory.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: true + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: is_internal + description: Search for only internal categories. + schema: + type: boolean + - in: query + name: is_active + description: Search for only active categories + schema: + type: boolean + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/product-categories/getundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/product-categories/getundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + product_category: + type: array + items: + $ref: ../components/schemas/ProductCategory.yaml + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/product-categories_{id}.yaml b/docs/api/admin/paths/product-categories_{id}.yaml new file mode 100644 index 0000000000..2c89a0f662 --- /dev/null +++ b/docs/api/admin/paths/product-categories_{id}.yaml @@ -0,0 +1,105 @@ +delete: + operationId: DeleteProductCategoriesCategory + summary: Delete a Product Category + description: Deletes a ProductCategory. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/product-categories_{id}/deleteundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/product-categories_{id}/deleteundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the deleted product category. + object: + type: string + description: The type of the object that was deleted. + default: product_category + deleted: + type: boolean + description: Whether the product category was deleted successfully or not. + default: true + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/product-categories_{id}/getundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/product-categories_{id}/getundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Category + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + productCategory: + $ref: ../components/schemas/ProductCategory.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml b/docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml new file mode 100644 index 0000000000..57a80b1051 --- /dev/null +++ b/docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml @@ -0,0 +1,121 @@ +post: + operationId: PostSalesChannelsSalesChannelStockLocation + summary: Associate a stock location to a Sales Channel + description: Associates a stock location to a Sales Channel. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Sales Channel. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: >- + ../code_samples/JavaScript/sales-channels_{id}_stock-locations/postundefined + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/sales-channels_{id}_stock-locations/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + sales_channel: + $ref: ../components/schemas/SalesChannel.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteSalesChannelsSalesChannelStockLocation + summary: Remove a stock location from a Sales Channel + description: Removes a stock location from a Sales Channel. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Sales Channel. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: >- + ../code_samples/JavaScript/sales-channels_{id}_stock-locations/deleteundefined + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/sales-channels_{id}_stock-locations/deleteundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the removed stock location from a sales channel + object: + type: string + description: The type of the object that was removed. + default: stock-location + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/stock-locations.yaml b/docs/api/admin/paths/stock-locations.yaml new file mode 100644 index 0000000000..7677f046c3 --- /dev/null +++ b/docs/api/admin/paths/stock-locations.yaml @@ -0,0 +1,217 @@ +post: + operationId: PostStockLocations + summary: Create a Stock Location + description: Creates a Stock Location. + x-authenticated: true + parameters: + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostStockLocationsReq.yaml + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/stock-locations/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/stock-locations/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: ../components/schemas/StockLocationDTO.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +get: + operationId: GetStockLocations + summary: List Stock Locations + description: Retrieves a list of stock locations + x-authenticated: true + parameters: + - in: query + name: id + description: ID of the stock location + schema: + type: string + - in: query + name: name + description: Name of the stock location + schema: + type: string + - in: query + name: order + description: The field to order the results by. + schema: + type: string + - in: query + name: created_at + description: Date comparison for when resulting collections were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting collections were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: deleted_at + description: Date comparison for when resulting collections were deleted. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: offset + description: How many stock locations to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of stock locations returned. + schema: + type: integer + default: 20 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each stock location + of the result. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in each stock location + of the result. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/stock-locations/getundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/stock-locations/getundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Sales Channel + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_locations: + type: array + items: + $ref: ../components/schemas/StockLocationDTO.yaml + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/stock-locations_{id}.yaml b/docs/api/admin/paths/stock-locations_{id}.yaml new file mode 100644 index 0000000000..e7311484f4 --- /dev/null +++ b/docs/api/admin/paths/stock-locations_{id}.yaml @@ -0,0 +1,109 @@ +get: + operationId: GetStockLocationsStockLocation + summary: Get a Stock Location + description: Retrieves the Stock Location. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Stock Location. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/stock-locations_{id}/getundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/stock-locations_{id}/getundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: ../components/schemas/StockLocationDTO.yaml +post: + operationId: PostStockLocationsStockLocation + summary: Update a Stock Location + description: Updates a Stock Location. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Stock Location. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostStockLocationsLocationReq.yaml + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/stock-locations_{id}/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/stock-locations_{id}/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - Stock Location + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + stock_location: + $ref: ../components/schemas/StockLocationDTO.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index 4b3ac12e7f..8259e2d33f 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -6416,6 +6416,10 @@ components: fulfillment type: string example: manual + location_id: + description: The id of the stock location the fulfillment will be shipped from + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. $ref: '#/components/schemas/FulfillmentProvider' @@ -7957,6 +7961,13 @@ components: method that will be used to complete the purchase. type: boolean example: true + is_initiated: + description: >- + A flag to indicate if a communication with the third party provider + has been initiated. + type: boolean + example: true + default: false status: description: >- Indicates the status of the Payment Session. Will default to @@ -8171,6 +8182,65 @@ components: type: string description: The date with timezone at which the resource was deleted. format: date-time + ProductCategory: + title: ProductCategory + description: Represents a product category + x-resourceId: ProductCategory + type: object + required: + - name + properties: + id: + type: string + description: The product category's ID + example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 + name: + type: string + description: The product category's name + example: Regular Fit + handle: + description: >- + A unique string that identifies the Category - example: slug + structures. + type: string + example: regular-fit + mpath: + type: string + description: >- + A string for Materialized Paths - used for finding ancestors and + descendents + example: pcat_id1.pcat_id2.pcat_id3 + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + default: false + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + default: false + category_children: + description: Available if the relation `category_children` are expanded. + type: array + items: + type: object + description: A product category object. + parent_category: + description: >- + A product category object. Available if the relation + `parent_category` is expanded. + type: object + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. @@ -10186,6 +10256,195 @@ components: description: An optional key-value map with additional details example: car: white + StockLocationAddressDTO: + title: Stock Location Address + description: Represents a Stock Location Address + type: object + required: + - address_1 + - country_code + - created_at + - updated_at + properties: + id: + type: string + description: The stock location address' ID + example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + StockLocationDTO: + title: Stock Location + description: Represents a Stock Location + type: object + required: + - id + - name + - address_id + - created_at + - updated_at + properties: + id: + type: string + description: The stock location's ID + example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 + address_id: + type: string + description: Stock location address' ID + example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 + name: + type: string + description: The name of the stock location + example: Main Warehouse + address: + description: The Address of the Stock Location + allOf: + - $ref: '#/components/schemas/StockLocationAddressDTO' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + StockLocationAddressInput: + title: Stock Location Address Input + description: Represents a Stock Location Address Input + type: object + required: + - address_1 + - country_code + properties: + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + CreateStockLocationInput: + title: Create Stock Location Input + description: Represents the Input to create a Stock Location + type: object + required: + - name + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + UpdateStockLocationInput: + title: Update Stock Location Input + description: Represents the Input to update a Stock Location + type: object + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white MultipleErrors: title: Multiple Errors type: object diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index 4b3ac12e7f..8259e2d33f 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -6416,6 +6416,10 @@ components: fulfillment type: string example: manual + location_id: + description: The id of the stock location the fulfillment will be shipped from + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. $ref: '#/components/schemas/FulfillmentProvider' @@ -7957,6 +7961,13 @@ components: method that will be used to complete the purchase. type: boolean example: true + is_initiated: + description: >- + A flag to indicate if a communication with the third party provider + has been initiated. + type: boolean + example: true + default: false status: description: >- Indicates the status of the Payment Session. Will default to @@ -8171,6 +8182,65 @@ components: type: string description: The date with timezone at which the resource was deleted. format: date-time + ProductCategory: + title: ProductCategory + description: Represents a product category + x-resourceId: ProductCategory + type: object + required: + - name + properties: + id: + type: string + description: The product category's ID + example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 + name: + type: string + description: The product category's name + example: Regular Fit + handle: + description: >- + A unique string that identifies the Category - example: slug + structures. + type: string + example: regular-fit + mpath: + type: string + description: >- + A string for Materialized Paths - used for finding ancestors and + descendents + example: pcat_id1.pcat_id2.pcat_id3 + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + default: false + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + default: false + category_children: + description: Available if the relation `category_children` are expanded. + type: array + items: + type: object + description: A product category object. + parent_category: + description: >- + A product category object. Available if the relation + `parent_category` is expanded. + type: object + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. @@ -10186,6 +10256,195 @@ components: description: An optional key-value map with additional details example: car: white + StockLocationAddressDTO: + title: Stock Location Address + description: Represents a Stock Location Address + type: object + required: + - address_1 + - country_code + - created_at + - updated_at + properties: + id: + type: string + description: The stock location address' ID + example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + StockLocationDTO: + title: Stock Location + description: Represents a Stock Location + type: object + required: + - id + - name + - address_id + - created_at + - updated_at + properties: + id: + type: string + description: The stock location's ID + example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 + address_id: + type: string + description: Stock location address' ID + example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 + name: + type: string + description: The name of the stock location + example: Main Warehouse + address: + description: The Address of the Stock Location + allOf: + - $ref: '#/components/schemas/StockLocationAddressDTO' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + StockLocationAddressInput: + title: Stock Location Address Input + description: Represents a Stock Location Address Input + type: object + required: + - address_1 + - country_code + properties: + address_1: + type: string + description: Stock location address + example: '35, Jhon Doe Ave' + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + CreateStockLocationInput: + title: Create Stock Location Input + description: Represents the Input to create a Stock Location + type: object + required: + - name + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + UpdateStockLocationInput: + title: Update Stock Location Input + description: Represents the Input to update a Stock Location + type: object + properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: '#/components/schemas/StockLocationAddressInput' + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white MultipleErrors: title: Multiple Errors type: object diff --git a/docs/api/store/components/schemas/CreateStockLocationInput.yaml b/docs/api/store/components/schemas/CreateStockLocationInput.yaml new file mode 100644 index 0000000000..6a8d7255f5 --- /dev/null +++ b/docs/api/store/components/schemas/CreateStockLocationInput.yaml @@ -0,0 +1,22 @@ +title: Create Stock Location Input +description: Represents the Input to create a Stock Location +type: object +required: + - name +properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: ./StockLocationAddressInput.yaml + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/store/components/schemas/Fulfillment.yaml b/docs/api/store/components/schemas/Fulfillment.yaml index 0c34d6607b..8567463bfe 100644 --- a/docs/api/store/components/schemas/Fulfillment.yaml +++ b/docs/api/store/components/schemas/Fulfillment.yaml @@ -42,6 +42,10 @@ properties: fulfillment type: string example: manual + location_id: + description: The id of the stock location the fulfillment will be shipped from + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. $ref: ./FulfillmentProvider.yaml diff --git a/docs/api/store/components/schemas/PaymentSession.yaml b/docs/api/store/components/schemas/PaymentSession.yaml index 3d7e87862b..440d532f58 100644 --- a/docs/api/store/components/schemas/PaymentSession.yaml +++ b/docs/api/store/components/schemas/PaymentSession.yaml @@ -33,6 +33,13 @@ properties: that will be used to complete the purchase. type: boolean example: true + is_initiated: + description: >- + A flag to indicate if a communication with the third party provider has + been initiated. + type: boolean + example: true + default: false status: description: >- Indicates the status of the Payment Session. Will default to `pending`, diff --git a/docs/api/store/components/schemas/ProductCategory.yaml b/docs/api/store/components/schemas/ProductCategory.yaml new file mode 100644 index 0000000000..135a745936 --- /dev/null +++ b/docs/api/store/components/schemas/ProductCategory.yaml @@ -0,0 +1,56 @@ +title: ProductCategory +description: Represents a product category +x-resourceId: ProductCategory +type: object +required: + - name +properties: + id: + type: string + description: The product category's ID + example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 + name: + type: string + description: The product category's name + example: Regular Fit + handle: + description: 'A unique string that identifies the Category - example: slug structures.' + type: string + example: regular-fit + mpath: + type: string + description: >- + A string for Materialized Paths - used for finding ancestors and + descendents + example: pcat_id1.pcat_id2.pcat_id3 + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + default: false + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + default: false + category_children: + description: Available if the relation `category_children` are expanded. + type: array + items: + type: object + description: A product category object. + parent_category: + description: >- + A product category object. Available if the relation `parent_category` is + expanded. + type: object + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time diff --git a/docs/api/store/components/schemas/StockLocationAddressDTO.yaml b/docs/api/store/components/schemas/StockLocationAddressDTO.yaml new file mode 100644 index 0000000000..de9461efb2 --- /dev/null +++ b/docs/api/store/components/schemas/StockLocationAddressDTO.yaml @@ -0,0 +1,58 @@ +title: Stock Location Address +description: Represents a Stock Location Address +type: object +required: + - address_1 + - country_code + - created_at + - updated_at +properties: + id: + type: string + description: The stock location address' ID + example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 + address_1: + type: string + description: Stock location address + example: 35, Jhon Doe Ave + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/store/components/schemas/StockLocationAddressInput.yaml b/docs/api/store/components/schemas/StockLocationAddressInput.yaml new file mode 100644 index 0000000000..700d86deb8 --- /dev/null +++ b/docs/api/store/components/schemas/StockLocationAddressInput.yaml @@ -0,0 +1,40 @@ +title: Stock Location Address Input +description: Represents a Stock Location Address Input +type: object +required: + - address_1 + - country_code +properties: + address_1: + type: string + description: Stock location address + example: 35, Jhon Doe Ave + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/store/components/schemas/StockLocationDTO.yaml b/docs/api/store/components/schemas/StockLocationDTO.yaml new file mode 100644 index 0000000000..e4233fd30d --- /dev/null +++ b/docs/api/store/components/schemas/StockLocationDTO.yaml @@ -0,0 +1,44 @@ +title: Stock Location +description: Represents a Stock Location +type: object +required: + - id + - name + - address_id + - created_at + - updated_at +properties: + id: + type: string + description: The stock location's ID + example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 + address_id: + type: string + description: Stock location address' ID + example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 + name: + type: string + description: The name of the stock location + example: Main Warehouse + address: + description: The Address of the Stock Location + allOf: + - $ref: ./StockLocationAddressDTO.yaml + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white + created_at: + type: string + description: The date with timezone at which the resource was created. + format: date-time + updated_at: + type: string + description: The date with timezone at which the resource was updated. + format: date-time + deleted_at: + type: string + description: The date with timezone at which the resource was deleted. + format: date-time diff --git a/docs/api/store/components/schemas/UpdateStockLocationInput.yaml b/docs/api/store/components/schemas/UpdateStockLocationInput.yaml new file mode 100644 index 0000000000..6b14b20a0e --- /dev/null +++ b/docs/api/store/components/schemas/UpdateStockLocationInput.yaml @@ -0,0 +1,20 @@ +title: Update Stock Location Input +description: Represents the Input to update a Stock Location +type: object +properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: ./StockLocationAddressInput.yaml + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white From c10437f22c8369bfb146adbf9be92ba6f7370d24 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 11 Jan 2023 18:52:59 +0200 Subject: [PATCH 03/14] docs: fix note about migration script in upgrade guide (#2996) --- docs/content/advanced/backend/upgrade-guides/1-7-3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/advanced/backend/upgrade-guides/1-7-3.md b/docs/content/advanced/backend/upgrade-guides/1-7-3.md index cfa8118fc1..634c0de460 100644 --- a/docs/content/advanced/backend/upgrade-guides/1-7-3.md +++ b/docs/content/advanced/backend/upgrade-guides/1-7-3.md @@ -26,7 +26,7 @@ medusa migrations run ### Run Migration Script for Sales Channels -With the introduction of Sales Channels, products are now associated with them. To avoid inconsistencies with how products are linked to Sales Channels, it’s strongly recommended to run a migration script before running the Medusa server. +With the introduction of Sales Channels, products are now associated with them. To avoid inconsistencies with how products are linked to Sales Channels, it’s strongly recommended to run a migration script right after running the Medusa server the first time. Start by adding the following environment variables: From cbd5943ddb5683cc7a68cce75fa249c6e17f6ea2 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 11 Jan 2023 19:09:06 +0200 Subject: [PATCH 04/14] docs: updated user guide following sidebar redesign of admin (#2998) --- docs/content/user-guide/index.mdx | 12 +++++------- docs/content/user-guide/users/index.md | 2 ++ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/content/user-guide/index.mdx b/docs/content/user-guide/index.mdx index 8e125d5f8c..d906804b6c 100644 --- a/docs/content/user-guide/index.mdx +++ b/docs/content/user-guide/index.mdx @@ -15,7 +15,7 @@ If you don’t have a Medusa admin yet, you can check [the live demo](https://de ::: -![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1667923680/Medusa%20Docs/User%20Guide/RdrJznk_ejddsm.png) +![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1673455647/Medusa%20Docs/User%20Guide/Screenshot_2023-01-11_at_6.46.06_PM_sirvel.png) ## Accessing the Medusa Admin @@ -35,9 +35,7 @@ After you log into your Medusa admin, you can see a sidebar menu, a search bar a The sidebar menu includes the main navigation of your Medusa admin. You can use it to navigate between different pages, such as Products or Orders pages. -You can also see your team members in the sidebar menu. These are the users that can access the Medusa Admin. - -![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1667923971/Medusa%20Docs/User%20Guide/KZlWoUi_pf5a2f.png) +![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1673455798/Medusa%20Docs/User%20Guide/Screenshot_2023-01-11_at_6.49.48_PM_bj2bik.png) ### Search Bar @@ -55,7 +53,7 @@ Mac OS: + K ![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1667923987/Medusa%20Docs/User%20Guide/z9a1NLK_ojyfn0.png) -You can either select a resolve with your mouse, or use the up and down arrows on your keyboard to navigate between the results, then choosing a result by hitting the Enter key. +You can select a result with your mouse. Alternatively, use the up and down arrows on your keyboard to navigate between the results, then choosing a result by hitting the Enter key. ### Check Notifications @@ -65,9 +63,9 @@ At the top right you’ll find a { - throw new Error('Method not implemented.') + throw new Error("Method not implemented.") } buildTemplate(): Promise { - throw new Error('Method not implemented.') + throw new Error("Method not implemented.") } } @@ -78,10 +81,10 @@ Since only one batch job strategy can handle a batch job type, you can overwrite So, for example, to overwrite the product import strategy set the `batchType` property in your strategy to `product-import`: -```typescript +```ts class MyImportStrategy extends AbstractBatchJobStrategy { - static batchType = 'product-import' - //... + static batchType = "product-import" + // ... } ``` diff --git a/docs/content/advanced/backend/endpoints/add-middleware.md b/docs/content/advanced/backend/endpoints/add-middleware.md new file mode 100644 index 0000000000..0049545e67 --- /dev/null +++ b/docs/content/advanced/backend/endpoints/add-middleware.md @@ -0,0 +1,72 @@ +# How to Add a Middleware + +In this document, you’ll learn how to add a middleware to an existing or custom route in Medusa. + +## Overview + +As the Medusa server is built on top of [Express](https://expressjs.com/), Express’s features can be utilized during your development with Medusa. + +One feature in particular is adding a [middleware](http://expressjs.com/en/guide/using-middleware.html#using-middleware). A middleware is a function that has access to the request and response objects. + +A middleware can be used to perform an action when an endpoint is called or modify the response, among other usages. + +You can add a middleware to an existing route in the Medusa server, a route in a plugin, or your custom routes. + +--- + +## Add a Middleware + +Adding a middleware is very similar to adding a custom endpoint. The middleware must be created either in the `src/api/index.ts` entry point, or other TypeScript or JavaScript files imported into `src/api/index.ts`. + +:::info + +Learn more about creating custom endpoints in [this documentation](./add.md). + +::: + +The following code snippet is an example of adding a middleware: + +```ts title=src/api/index.ts +import { Router } from "express" + +export default () => { + const router = Router() + + router.use("/store/products", (req, res, next) => { + // / perform an action when retrieving products + next() + }) + + return router +} +``` + +This code snippet adds a middleware to the [List Products](/api/store/#tag/Product/operation/GetProducts) endpoint. In the middleware function, you can perform any action. + +Then, you must call the `next` method received as a third parameter in the middleware function to ensure that the endpoint executes after the middleware. + +:::info + +You can learn more about Middlewares and their capabilities in [Express’s documentation](http://expressjs.com/en/guide/using-middleware.html#using-middleware). + +::: + +--- + +## Building Files + +Similar to custom endpoints, you must transpile the files under `src` into the `dist` directory for the server to load them. + +To do that, run the following command before running the Medusa server: + +```bash npm2yarn +npm run build +``` + +--- + +## See Also + +- [Create an Endpoint](./add.md) +- [Store API reference](/api/store) +- [Admin API reference](/api/admin) diff --git a/docs/content/advanced/backend/endpoints/add.md b/docs/content/advanced/backend/endpoints/add.md index e0cc102b78..34c5b1a195 100644 --- a/docs/content/advanced/backend/endpoints/add.md +++ b/docs/content/advanced/backend/endpoints/add.md @@ -295,6 +295,7 @@ npm run build ## See Also +- [Add a Middleware](./add-middleware.md) - [Storefront API Reference](/api/store) - [Admin API Reference](/api/admin) - [Create a Service](./../services/create-service.md). diff --git a/docs/content/advanced/backend/price-selection-strategy/override.md b/docs/content/advanced/backend/price-selection-strategy/override.md index ad21f5949d..dc4b93bf90 100644 --- a/docs/content/advanced/backend/price-selection-strategy/override.md +++ b/docs/content/advanced/backend/price-selection-strategy/override.md @@ -12,46 +12,51 @@ If you’re interested in learning what a price selection strategy is and how it Create a TypeScript or JavaScript file in `src/strategies` of your Medusa server project with a class that extends the `AbstractPriceSelectionStrategy` class: -```typescript title=src/strategies/price.ts -import { AbstractPriceSelectionStrategy, IPriceSelectionStrategy, PriceSelectionContext, PriceSelectionResult } from "@medusajs/medusa"; +```ts title=src/strategies/price.ts +import { + AbstractPriceSelectionStrategy, + IPriceSelectionStrategy, + PriceSelectionContext, + PriceSelectionResult, +} from "@medusajs/medusa" -import { EntityManager } from "typeorm"; +import { EntityManager } from "typeorm" -export default class MyPriceListStrategy extends AbstractPriceSelectionStrategy { +export default class MyStrategy extends AbstractPriceSelectionStrategy { withTransaction(manager: EntityManager): IPriceSelectionStrategy { if (!manager) { return this } - return new MyPriceListStrategy() + return new MyStrategy() } async calculateVariantPrice( variant_id: string, context: PriceSelectionContext ): Promise { - //TODO + // TODO } } ``` -You can use services or repositories in the strategy by adding them to the constructor and updating the parameters passed to the `MyPriceListStrategy` constructor in `withTransaction`. For example: +You can use services or repositories in the strategy by adding them to the constructor and updating the parameters passed to the `MyStrategy` constructor in `withTransaction`. For example: -```typescript +```ts import { AbstractPriceSelectionStrategy, CustomerService, IPriceSelectionStrategy, PriceSelectionContext, - PriceSelectionResult -} from "@medusajs/medusa"; + PriceSelectionResult, +} from "@medusajs/medusa" -export default class MyPriceListStrategy extends AbstractPriceSelectionStrategy { +export default class MyStrategy extends AbstractPriceSelectionStrategy { private customerService: CustomerService constructor({ - customerService + customerService, }) { super() this.customerService = customerService @@ -62,11 +67,11 @@ export default class MyPriceListStrategy extends AbstractPriceSelectionStrategy return this } - return new MyPriceListStrategy({ - customerService: this.customerService + return new MyStrategy({ + customerService: this.customerService, }) } - //... + // ... } ``` @@ -80,10 +85,10 @@ This method accepts the variant ID as a first parameter and the [context](./inde This method must return an object having the following fields: -```typescript noReport +```ts noReport { - originalPrice, //number | null - calculatedPrice, //number | null + originalPrice, // number | null + calculatedPrice, // number | null prices // MoneyAmount[] } ``` diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index a86049be54..259e647159 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -368,6 +368,11 @@ module.exports = { id: "advanced/backend/endpoints/add", label: "Create an Endpoint" }, + { + type: "doc", + id: "advanced/backend/endpoints/add-middleware", + label: "Add a Middleware" + }, { type: "doc", id: "advanced/backend/services/create-service", From 2c2c70d88c274f886aa96ca7e2592e4bae3946c7 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 13 Jan 2023 09:21:50 +0200 Subject: [PATCH 07/14] chore(oas): fixed oas for product category endpoints and model (#3019) --- .../product-categories/create-product-category.ts | 14 +------------- .../product-categories/delete-product-category.ts | 10 ---------- .../product-categories/get-product-category.ts | 14 ++------------ .../product-categories/list-product-categories.ts | 14 ++------------ packages/medusa/src/models/product-category.ts | 4 ++++ 5 files changed, 9 insertions(+), 47 deletions(-) diff --git a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts index de9860f994..22048a68b8 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts @@ -21,18 +21,6 @@ import { FindParams } from "../../../../types/common" * schema: * $ref: "#/components/schemas/AdminPostProductCategoriesReq" * x-codeSamples: - * - lang: JavaScript - * label: JS Client - * source: | - * import Medusa from "@medusajs/medusa-js" - * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - * // must be previously logged in or use api token - * medusa.admin.productCategories.create({ - * name: 'Jeans', - * }) - * .then(({ productCategory }) => { - * console.log(productCategory.id); - * }); * - lang: Shell * label: cURL * source: | @@ -55,7 +43,7 @@ import { FindParams } from "../../../../types/common" * schema: * type: object * properties: - * productCategory: + * product_category: * $ref: "#/components/schemas/ProductCategory" * "400": * $ref: "#/components/responses/400_error" diff --git a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts index 4ddf1521bf..3f0d5a9387 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts @@ -12,16 +12,6 @@ import { ProductCategoryService } from "../../../../services" * parameters: * - (path) id=* {string} The ID of the Product Category * x-codeSamples: - * - lang: JavaScript - * label: JS Client - * source: | - * import Medusa from "@medusajs/medusa-js" - * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - * // must be previously logged in or use api token - * medusa.admin.productCategories.delete(product_category_id) - * .then(({ id, object, deleted }) => { - * console.log(id); - * }); * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts index 07d54c908f..92fa17da4b 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts @@ -13,16 +13,6 @@ import { defaultAdminProductCategoryRelations } from "." * parameters: * - (path) id=* {string} The ID of the Product Category * x-codeSamples: - * - lang: JavaScript - * label: JS Client - * source: | - * import Medusa from "@medusajs/medusa-js" - * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - * // must be previously logged in or use api token - * medusa.admin.productCategories.retrieve("pcat-id") - * .then(({ productCategory }) => { - * console.log(productCategory.id); - * }); * - lang: Shell * label: cURL * source: | @@ -32,7 +22,7 @@ import { defaultAdminProductCategoryRelations } from "." * - api_token: [] * - cookie_auth: [] * tags: - * - Category + * - Product Category * responses: * "200": * description: OK @@ -41,7 +31,7 @@ import { defaultAdminProductCategoryRelations } from "." * schema: * type: object * properties: - * productCategory: + * product_category: * $ref: "#/components/schemas/ProductCategory" * "400": * $ref: "#/components/responses/400_error" diff --git a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts index bee1511fba..641448e00b 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts @@ -19,16 +19,6 @@ import { extendedFindParamsMixin } from "../../../../types/common" * - (query) offset=0 {integer} How many product categories to skip in the result. * - (query) limit=100 {integer} Limit the number of product categories returned. * x-codeSamples: - * - lang: JavaScript - * label: JS Client - * source: | - * import Medusa from "@medusajs/medusa-js" - * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - * // must be previously logged in or use api token - * medusa.admin.productCategories.list() - * .then(({ product_category, limit, offset, count }) => { - * console.log(product_category.length); - * }); * - lang: Shell * label: cURL * source: | @@ -38,7 +28,7 @@ import { extendedFindParamsMixin } from "../../../../types/common" * - api_token: [] * - cookie_auth: [] * tags: - * - Product Categories + * - Product Category * responses: * 200: * description: OK @@ -47,7 +37,7 @@ import { extendedFindParamsMixin } from "../../../../types/common" * schema: * type: object * properties: - * product_category: + * product_categories: * type: array * items: * $ref: "#/components/schemas/ProductCategory" diff --git a/packages/medusa/src/models/product-category.ts b/packages/medusa/src/models/product-category.ts index 3155f2c768..f7a32129d8 100644 --- a/packages/medusa/src/models/product-category.ts +++ b/packages/medusa/src/models/product-category.ts @@ -96,6 +96,10 @@ export class ProductCategory extends SoftDeletableEntity { * items: * type: object * description: A product category object. + * parent_category_id: + * description: The ID of the parent category. + * type: string + * default: null * parent_category: * description: A product category object. Available if the relation `parent_category` is expanded. * type: object From 853f8efdf3abf46d25de5dd2f0cae4850df64fbe Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 13 Jan 2023 09:27:24 +0200 Subject: [PATCH 08/14] chore(docs): Generated API Reference (#3021) Co-authored-by: shahednasser --- docs/api/admin-spec3.json | 76 +++---------------- docs/api/admin-spec3.yaml | 76 +++---------------- .../product-categories/getundefined | 7 -- .../product-categories/postundefined | 9 --- .../product-categories_{id}/deleteundefined | 7 -- .../product-categories_{id}/getundefined | 7 -- .../components/schemas/ProductCategory.yaml | 4 + docs/api/admin/paths/product-categories.yaml | 14 +--- .../admin/paths/product-categories_{id}.yaml | 12 +-- docs/api/store-spec3.json | 4 + docs/api/store-spec3.yaml | 4 + .../components/schemas/ProductCategory.yaml | 4 + 12 files changed, 39 insertions(+), 185 deletions(-) delete mode 100644 docs/api/admin/code_samples/JavaScript/product-categories/getundefined delete mode 100644 docs/api/admin/code_samples/JavaScript/product-categories/postundefined delete mode 100644 docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined delete mode 100644 docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index e03ef39e05..3da4c57742 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -10643,23 +10643,6 @@ paths: schema: $ref: '#/components/schemas/AdminPostProductCategoriesReq' x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.create({ - name: 'Jeans', - }) - - .then(({ productCategory }) => { - console.log(productCategory.id); - }); - lang: Shell label: cURL source: > @@ -10686,7 +10669,7 @@ paths: schema: type: object properties: - productCategory: + product_category: $ref: '#/components/schemas/ProductCategory' '400': $ref: '#/components/responses/400_error' @@ -10739,21 +10722,6 @@ paths: type: integer default: 100 x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.list() - - .then(({ product_category, limit, offset, count }) => { - console.log(product_category.length); - }); - lang: Shell label: cURL source: > @@ -10765,7 +10733,7 @@ paths: - api_token: [] - cookie_auth: [] tags: - - Product Categories + - Product Category responses: '200': description: OK @@ -10774,7 +10742,7 @@ paths: schema: type: object properties: - product_category: + product_categories: type: array items: $ref: '#/components/schemas/ProductCategory' @@ -10813,21 +10781,6 @@ paths: schema: type: string x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.delete(product_category_id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - lang: Shell label: cURL source: > @@ -10886,21 +10839,6 @@ paths: schema: type: string x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.retrieve("pcat-id") - - .then(({ productCategory }) => { - console.log(productCategory.id); - }); - lang: Shell label: cURL source: > @@ -10912,7 +10850,7 @@ paths: - api_token: [] - cookie_auth: [] tags: - - Category + - Product Category responses: '200': description: OK @@ -10921,7 +10859,7 @@ paths: schema: type: object properties: - productCategory: + product_category: $ref: '#/components/schemas/ProductCategory' '400': $ref: '#/components/responses/400_error' @@ -22847,6 +22785,10 @@ components: items: type: object description: A product category object. + parent_category_id: + description: The ID of the parent category. + type: string + default: null parent_category: description: >- A product category object. Available if the relation diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index e03ef39e05..3da4c57742 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -10643,23 +10643,6 @@ paths: schema: $ref: '#/components/schemas/AdminPostProductCategoriesReq' x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.create({ - name: 'Jeans', - }) - - .then(({ productCategory }) => { - console.log(productCategory.id); - }); - lang: Shell label: cURL source: > @@ -10686,7 +10669,7 @@ paths: schema: type: object properties: - productCategory: + product_category: $ref: '#/components/schemas/ProductCategory' '400': $ref: '#/components/responses/400_error' @@ -10739,21 +10722,6 @@ paths: type: integer default: 100 x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.list() - - .then(({ product_category, limit, offset, count }) => { - console.log(product_category.length); - }); - lang: Shell label: cURL source: > @@ -10765,7 +10733,7 @@ paths: - api_token: [] - cookie_auth: [] tags: - - Product Categories + - Product Category responses: '200': description: OK @@ -10774,7 +10742,7 @@ paths: schema: type: object properties: - product_category: + product_categories: type: array items: $ref: '#/components/schemas/ProductCategory' @@ -10813,21 +10781,6 @@ paths: schema: type: string x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.delete(product_category_id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - lang: Shell label: cURL source: > @@ -10886,21 +10839,6 @@ paths: schema: type: string x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.retrieve("pcat-id") - - .then(({ productCategory }) => { - console.log(productCategory.id); - }); - lang: Shell label: cURL source: > @@ -10912,7 +10850,7 @@ paths: - api_token: [] - cookie_auth: [] tags: - - Category + - Product Category responses: '200': description: OK @@ -10921,7 +10859,7 @@ paths: schema: type: object properties: - productCategory: + product_category: $ref: '#/components/schemas/ProductCategory' '400': $ref: '#/components/responses/400_error' @@ -22847,6 +22785,10 @@ components: items: type: object description: A product category object. + parent_category_id: + description: The ID of the parent category. + type: string + default: null parent_category: description: >- A product category object. Available if the relation diff --git a/docs/api/admin/code_samples/JavaScript/product-categories/getundefined b/docs/api/admin/code_samples/JavaScript/product-categories/getundefined deleted file mode 100644 index 328cf218a4..0000000000 --- a/docs/api/admin/code_samples/JavaScript/product-categories/getundefined +++ /dev/null @@ -1,7 +0,0 @@ -import Medusa from "@medusajs/medusa-js" -const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) -// must be previously logged in or use api token -medusa.admin.productCategories.list() -.then(({ product_category, limit, offset, count }) => { - console.log(product_category.length); -}); diff --git a/docs/api/admin/code_samples/JavaScript/product-categories/postundefined b/docs/api/admin/code_samples/JavaScript/product-categories/postundefined deleted file mode 100644 index cd4b7f79e6..0000000000 --- a/docs/api/admin/code_samples/JavaScript/product-categories/postundefined +++ /dev/null @@ -1,9 +0,0 @@ -import Medusa from "@medusajs/medusa-js" -const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) -// must be previously logged in or use api token -medusa.admin.productCategories.create({ - name: 'Jeans', -}) -.then(({ productCategory }) => { - console.log(productCategory.id); -}); diff --git a/docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined b/docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined deleted file mode 100644 index 3f79a9da46..0000000000 --- a/docs/api/admin/code_samples/JavaScript/product-categories_{id}/deleteundefined +++ /dev/null @@ -1,7 +0,0 @@ -import Medusa from "@medusajs/medusa-js" -const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) -// must be previously logged in or use api token -medusa.admin.productCategories.delete(product_category_id) -.then(({ id, object, deleted }) => { - console.log(id); -}); diff --git a/docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined b/docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined deleted file mode 100644 index 9956745cd5..0000000000 --- a/docs/api/admin/code_samples/JavaScript/product-categories_{id}/getundefined +++ /dev/null @@ -1,7 +0,0 @@ -import Medusa from "@medusajs/medusa-js" -const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) -// must be previously logged in or use api token -medusa.admin.productCategories.retrieve("pcat-id") -.then(({ productCategory }) => { - console.log(productCategory.id); -}); diff --git a/docs/api/admin/components/schemas/ProductCategory.yaml b/docs/api/admin/components/schemas/ProductCategory.yaml index 135a745936..2a4074e25d 100644 --- a/docs/api/admin/components/schemas/ProductCategory.yaml +++ b/docs/api/admin/components/schemas/ProductCategory.yaml @@ -37,6 +37,10 @@ properties: items: type: object description: A product category object. + parent_category_id: + description: The ID of the parent category. + type: string + default: null parent_category: description: >- A product category object. Available if the relation `parent_category` is diff --git a/docs/api/admin/paths/product-categories.yaml b/docs/api/admin/paths/product-categories.yaml index 1510953bf8..34fb79228e 100644 --- a/docs/api/admin/paths/product-categories.yaml +++ b/docs/api/admin/paths/product-categories.yaml @@ -24,10 +24,6 @@ post: schema: $ref: ../components/schemas/AdminPostProductCategoriesReq.yaml x-codeSamples: - - lang: JavaScript - label: JS Client - source: - $ref: ../code_samples/JavaScript/product-categories/postundefined - lang: Shell label: cURL source: @@ -45,7 +41,7 @@ post: schema: type: object properties: - productCategory: + product_category: $ref: ../components/schemas/ProductCategory.yaml '400': $ref: ../components/responses/400_error.yaml @@ -98,10 +94,6 @@ get: type: integer default: 100 x-codeSamples: - - lang: JavaScript - label: JS Client - source: - $ref: ../code_samples/JavaScript/product-categories/getundefined - lang: Shell label: cURL source: @@ -110,7 +102,7 @@ get: - api_token: [] - cookie_auth: [] tags: - - Product Categories + - Product Category responses: '200': description: OK @@ -119,7 +111,7 @@ get: schema: type: object properties: - product_category: + product_categories: type: array items: $ref: ../components/schemas/ProductCategory.yaml diff --git a/docs/api/admin/paths/product-categories_{id}.yaml b/docs/api/admin/paths/product-categories_{id}.yaml index 2c89a0f662..47550ecb39 100644 --- a/docs/api/admin/paths/product-categories_{id}.yaml +++ b/docs/api/admin/paths/product-categories_{id}.yaml @@ -11,10 +11,6 @@ delete: schema: type: string x-codeSamples: - - lang: JavaScript - label: JS Client - source: - $ref: ../code_samples/JavaScript/product-categories_{id}/deleteundefined - lang: Shell label: cURL source: @@ -68,10 +64,6 @@ get: schema: type: string x-codeSamples: - - lang: JavaScript - label: JS Client - source: - $ref: ../code_samples/JavaScript/product-categories_{id}/getundefined - lang: Shell label: cURL source: @@ -80,7 +72,7 @@ get: - api_token: [] - cookie_auth: [] tags: - - Category + - Product Category responses: '200': description: OK @@ -89,7 +81,7 @@ get: schema: type: object properties: - productCategory: + product_category: $ref: ../components/schemas/ProductCategory.yaml '400': $ref: ../components/responses/400_error.yaml diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index 8259e2d33f..c234b6d583 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -8224,6 +8224,10 @@ components: items: type: object description: A product category object. + parent_category_id: + description: The ID of the parent category. + type: string + default: null parent_category: description: >- A product category object. Available if the relation diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index 8259e2d33f..c234b6d583 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -8224,6 +8224,10 @@ components: items: type: object description: A product category object. + parent_category_id: + description: The ID of the parent category. + type: string + default: null parent_category: description: >- A product category object. Available if the relation diff --git a/docs/api/store/components/schemas/ProductCategory.yaml b/docs/api/store/components/schemas/ProductCategory.yaml index 135a745936..2a4074e25d 100644 --- a/docs/api/store/components/schemas/ProductCategory.yaml +++ b/docs/api/store/components/schemas/ProductCategory.yaml @@ -37,6 +37,10 @@ properties: items: type: object description: A product category object. + parent_category_id: + description: The ID of the parent category. + type: string + default: null parent_category: description: >- A product category object. Available if the relation `parent_category` is From e1292dca5f07836e3e77f75ac8679fc4bffd0b46 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 13 Jan 2023 15:20:03 +0200 Subject: [PATCH 09/14] chore(medusa-js): changed README to link to the docs (#3024) --- packages/medusa-js/README.md | 57 +----------------------------------- 1 file changed, 1 insertion(+), 56 deletions(-) diff --git a/packages/medusa-js/README.md b/packages/medusa-js/README.md index 2eae83815d..644b61d734 100644 --- a/packages/medusa-js/README.md +++ b/packages/medusa-js/README.md @@ -6,61 +6,6 @@ The Medusa JS Client provides easy access to the Medusa API from a client writte ## Documentation -You can learn more about this client and how to use it [our documentation](https://docs.medusajs.com/js-client/overview). +You can learn more about how to install and use this client in [our documentation](https://docs.medusajs.com/js-client/overview). To learn more about the API endpoints that this client allows you to access check out our [API reference](https://docs.medusajs.com/api/store). - -## Installation - -Install the package with: - -```sh -npm install @medusajs/medusa-js -# or -yarn add @medusajs/medusa-js -``` - -## Usage - -Import Medusa as a default import and initiate it: - -```js -import Medusa from "@medusajs/medusa-js" - -const medusa = new Medusa() - -const { cart } = await medusa.carts.create({}) -``` - -### Authentication - -Authentication can be achieved in two ways using the `medusa-js` client, either by utilizing API keys or by using cookie based authentication, each with their own unique use case. - -#### **Using API keys** - -API keys can only be used for admin functionality in Medusa because only users of the admin system have api keys. To use API keys for authentication the key should be used when `medusa-js` is initialized with a config object as described below. - -#### **Using cookies** - -Authentication using cookies is done automatically by Axios when authenticating using the `auth` endpoints. After authentication all subsequent calls will be authenticated. - -_note: Cookie based authentication cannot be used in plain `node.js` applications due to the limitations of axios and `useCredentials` not setting the `Cookie` request header when `set-cookie` is present in the response headers. For pure `node.js` applications use authentication with api keys(see above)_ - -## Configuration - -### Initialize with config object - -The package can be initialized with several options: - -```js -const medusa = new Medusa({ - maxRetries: 3, - baseUrl: "https://api.example.com", -}) -``` - -| Option | Default | Description | -| ------------ | ------------------------- | --------------------------------------------------------- | -| `maxRetries` | `0` | The amount of times a request is retried. | -| `baseUrl` | `'http://localhost:9000'` | The url to which requests are made to. | -| `apiKey` | `''` | Optional api key used for authenticating admin requests . | From dc26a28a5357cb7ca170f9420ca0f94d62fe91e4 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 13 Jan 2023 15:31:26 +0200 Subject: [PATCH 10/14] docs: improved feedback component (#3026) --- www/docs/package.json | 1 + www/docs/src/components/Feedback/index.js | 46 +++++++++++++++++------ www/docs/yarn.lock | 8 ++++ 3 files changed, 44 insertions(+), 11 deletions(-) diff --git a/www/docs/package.json b/www/docs/package.json index 0b5f31f235..5f35efa9f1 100644 --- a/www/docs/package.json +++ b/www/docs/package.json @@ -32,6 +32,7 @@ "react": "^17.0.1", "react-dom": "^17.0.1", "react-transition-group": "^4.4.5", + "react-uuid": "^2.0.0", "redocusaurus": "^1.4.0", "url-loader": "^4.1.1" }, diff --git a/www/docs/src/components/Feedback/index.js b/www/docs/src/components/Feedback/index.js index d1b13ccb6a..ead2a3c2b5 100644 --- a/www/docs/src/components/Feedback/index.js +++ b/www/docs/src/components/Feedback/index.js @@ -1,9 +1,10 @@ -import React, { useRef, useState } from 'react'; +import React, { useRef, useState, useEffect } from 'react'; import { CSSTransition, SwitchTransition } from 'react-transition-group'; import './index.css'; import useIsBrowser from '@docusaurus/useIsBrowser'; import {useLocation} from '@docusaurus/router'; +import uuid from 'react-uuid'; export default function Feedback ({ event, @@ -21,46 +22,69 @@ export default function Feedback ({ const inlineFeedbackRef = useRef(null); const inlineQuestionRef = useRef(null); const inlineMessageRef = useRef(null) - const [positiveFeedback, setPositiveFeedbac] = useState(false); + const [positiveFeedback, setPositiveFeedback] = useState(false); const [message, setMessage] = useState(""); + const [id, setId] = useState(null) const nodeRef = submittedFeedback ? inlineMessageRef : (showForm ? inlineQuestionRef : inlineFeedbackRef); const isBrowser = useIsBrowser(); const location = useLocation(); function handleFeedback (e) { - submitFeedback() - setPositiveFeedbac(e.target.classList.contains('positive')); + const feedback = e.target.classList.contains('positive'); + submitFeedback(e, feedback) + setPositiveFeedback(feedback); setShowForm(true); } - function submitFeedback () { + function submitFeedback (e, feedback = null) { + console.log(id, feedback, (feedback !== null && feedback) || (feedback === null && positiveFeedback) ? 'yes' : 'no') if (isBrowser) { + console.log("here1"); if (window.analytics) { + console.log("here3"); if (showForm) { setLoading(true); } + console.log("here4"); window.analytics.track(event, { url: location.pathname, label: document.title, - feedback: positiveFeedback ? 'yes' : 'no', - message + feedback: (feedback !== null && feedback) || (feedback === null && positiveFeedback) ? 'yes' : 'no', + message, + uuid: id }, function () { + console.log("here5"); if (showForm) { setLoading(false); - setShowForm(false); - setSubmittedFeedback(true); + console.log("here6"); + resetForm(); } }) } else { + console.log("here7"); if (showForm) { - setShowForm(false); - setSubmittedFeedback(true); + console.log("here8"); + resetForm(); } } } } + function resetForm () { + setShowForm(false); + setSubmittedFeedback(true); + if (message) { + setId(null); + } + } + + useEffect(() => { + if (!id) { + setId(uuid()) + } + }, [id]) + return (
diff --git a/www/docs/yarn.lock b/www/docs/yarn.lock index 969b45f8ac..3090bd6535 100644 --- a/www/docs/yarn.lock +++ b/www/docs/yarn.lock @@ -5528,6 +5528,7 @@ __metadata: react: ^17.0.1 react-dom: ^17.0.1 react-transition-group: ^4.4.5 + react-uuid: ^2.0.0 redocusaurus: ^1.4.0 url-loader: ^4.1.1 languageName: unknown @@ -9892,6 +9893,13 @@ __metadata: languageName: node linkType: hard +"react-uuid@npm:^2.0.0": + version: 2.0.0 + resolution: "react-uuid@npm:2.0.0" + checksum: 91f35c83911a2072f181eee0092b45f9ea3590d22268cf8418721756d53205dd9029a873b36a00913807651a0ea5548cc0fc60bad8c4f09bcd7cb03e6ae39ecf + languageName: node + linkType: hard + "react@npm:^17.0.1": version: 17.0.2 resolution: "react@npm:17.0.2" From 5c6931953aa40dac28ba0b228c759e47ce17e6cf Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 16 Jan 2023 11:22:38 +0200 Subject: [PATCH 11/14] docs: fixed note about database_schema option (#3037) --- docs/content/usage/configurations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/usage/configurations.md b/docs/content/usage/configurations.md index ad5a6f6661..55f0e1de10 100644 --- a/docs/content/usage/configurations.md +++ b/docs/content/usage/configurations.md @@ -79,7 +79,7 @@ module.exports = { Where `database_type` is `postgres` and `DATABASE_URL` is the URL connection string to your PostgreSQL database. You can check out how to format it in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html). -You can optionally set the `database_schema` option. By default, its value is `public`. +You can optionally set the `database_schema` option. By default, its value is `public`. When you set the `database_schema` option, you must add the `search_path` option to the database URL. For example, the value of `database_url` is `postgres://localhost/store?options=-c search_path=test` if `database_schema` is `test`. It's recommended to set the Database URL as an environment variable: From cb252440079f34ddfdfff1b891f6f73b98db9d59 Mon Sep 17 00:00:00 2001 From: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com> Date: Mon, 16 Jan 2023 11:44:24 -0500 Subject: [PATCH 12/14] hotfix(medusa-js, medusa-react): Fix issue with JS client bundle (#3038) --- .changeset/witty-parents-wink.md | 6 + packages/medusa-js/jest.config.js | 13 +- packages/medusa-js/package.json | 36 +- packages/medusa-js/rollup.config.js | 34 -- packages/medusa-js/src/index.ts | 7 +- .../medusa-js/src/resources/admin/uploads.ts | 40 +- packages/medusa-js/src/typings.ts | 2 + packages/medusa-js/tsconfig.json | 3 +- packages/medusa-js/tsup.config.ts | 16 + packages/medusa-react/src/contexts/medusa.tsx | 2 +- .../src/hooks/admin/uploads/mutations.ts | 11 +- yarn.lock | 572 +++++++++++++----- 12 files changed, 517 insertions(+), 225 deletions(-) create mode 100644 .changeset/witty-parents-wink.md delete mode 100644 packages/medusa-js/rollup.config.js create mode 100644 packages/medusa-js/tsup.config.ts diff --git a/.changeset/witty-parents-wink.md b/.changeset/witty-parents-wink.md new file mode 100644 index 0000000000..df6bbe6974 --- /dev/null +++ b/.changeset/witty-parents-wink.md @@ -0,0 +1,6 @@ +--- +"@medusajs/medusa-js": patch +"medusa-react": patch +--- + +hotfix: Fixes bundling error making JS client unable to run in Node enviornments. Also fixes wrong payload type of admin file uploads. diff --git a/packages/medusa-js/jest.config.js b/packages/medusa-js/jest.config.js index 0e82112490..50fff6d7e5 100644 --- a/packages/medusa-js/jest.config.js +++ b/packages/medusa-js/jest.config.js @@ -1,7 +1,12 @@ module.exports = { - transform: { - "^.+\\.(t|j)sx?$": require.resolve("ts-jest"), + globals: { + "ts-jest": { + diagnostics: false, + isolatedModules: true, + }, }, - testRegex: "(/tests/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$", - moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"], + transform: { + ".(ts|tsx)$": require.resolve("ts-jest/dist/"), + }, + testEnvironment: "jsdom", } diff --git a/packages/medusa-js/package.json b/packages/medusa-js/package.json index 45c6eda36b..a3c70c1ea7 100644 --- a/packages/medusa-js/package.json +++ b/packages/medusa-js/package.json @@ -3,23 +3,30 @@ "version": "1.3.6", "description": "Client for Medusa Commerce Rest API", "main": "dist/index.js", - "module": "dist/index.esm.js", - "files": [ - "dist/**/*" - ], + "module": "dist/index.mjs", "types": "dist/index.d.ts", + "exports": { + ".": { + "import": "./dist/index.mjs", + "require": "./dist/index.js" + }, + "./package.json": "./package.json" + }, "scripts": { - "build": "rollup -c --bundleConfigAsCjs", + "build": "tsup src/index.ts", "prepare": "cross-env NODE_ENV=production yarn run build", "test": "jest --passWithNoTests" }, "author": "Oliver Juhl", "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, "dependencies": { - "axios": "0.26.1", - "form-data": "^4.0.0", + "axios": "^0.24.0", "qs": "^6.10.3", - "retry-axios": "^2.6.0" + "retry-axios": "^2.6.0", + "uuid": "^9.0.0" }, "peerDependencies": { "@medusajs/medusa": "^1.7.3" @@ -34,15 +41,12 @@ }, "devDependencies": { "@medusajs/medusa": "^1.7.3", - "@rollup/plugin-commonjs": "^24.0.0", - "@rollup/plugin-node-resolve": "^15.0.1", - "@types/jest": "^26.0.19", + "@types/uuid": "^9.0.0", "cross-env": "^7.0.3", - "jest": "^26.6.3", - "rollup": "^3.9.1", - "rollup-plugin-terser": "^7.0.2", - "rollup-plugin-typescript2": "^0.34.1", - "typescript": "^4.1.3" + "jest": "^27.4.7", + "ts-jest": "^27.1.5", + "tsup": "^6.5.0", + "typescript": "^4.9.4" }, "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", "homepage": "https://docs.medusajs.com/js-client/overview" diff --git a/packages/medusa-js/rollup.config.js b/packages/medusa-js/rollup.config.js deleted file mode 100644 index 6eac2240ab..0000000000 --- a/packages/medusa-js/rollup.config.js +++ /dev/null @@ -1,34 +0,0 @@ -import commonjs from "@rollup/plugin-commonjs" -import resolve from "@rollup/plugin-node-resolve" -import { defineConfig } from "rollup" -import { terser } from "rollup-plugin-terser" -import typescript from "rollup-plugin-typescript2" - -const packageJson = require("./package.json") - -export default defineConfig({ - input: "src/index.ts", - external: ["@medusajs/medusa"], - output: [ - { - file: packageJson.main, - format: "cjs", - sourcemap: true, - }, - { - file: packageJson.module, - format: "esm", - sourcemap: true, - }, - ], - plugins: [ - terser(), - resolve({ - browser: true, - }), - commonjs(), - typescript({ - useTsconfigDeclarationDir: true, - }), - ], -}) diff --git a/packages/medusa-js/src/index.ts b/packages/medusa-js/src/index.ts index f813c06068..7ab4f18f04 100644 --- a/packages/medusa-js/src/index.ts +++ b/packages/medusa-js/src/index.ts @@ -1,4 +1,5 @@ import MedusaError from "./error" +import KeyManager from "./key-manager" import Client, { Config } from "./request" import Admin from "./resources/admin" import AuthResource from "./resources/auth" @@ -6,18 +7,17 @@ import CartsResource from "./resources/carts" import CollectionsResource from "./resources/collections" import CustomersResource from "./resources/customers" import GiftCardsResource from "./resources/gift-cards" -import OrdersResource from "./resources/orders" import OrderEditsResource from "./resources/order-edits" +import OrdersResource from "./resources/orders" import PaymentCollectionsResource from "./resources/payment-collections" import PaymentMethodsResource from "./resources/payment-methods" -import ProductsResource from "./resources/products" import ProductTypesResource from "./resources/product-types" +import ProductsResource from "./resources/products" import RegionsResource from "./resources/regions" import ReturnReasonsResource from "./resources/return-reasons" import ReturnsResource from "./resources/returns" import ShippingOptionsResource from "./resources/shipping-options" import SwapsResource from "./resources/swaps" -import KeyManager from "./key-manager" class Medusa { private client: Client @@ -78,5 +78,4 @@ class Medusa { export default Medusa export { default as KeyManager } from "./key-manager" - export * from "./typings" diff --git a/packages/medusa-js/src/resources/admin/uploads.ts b/packages/medusa-js/src/resources/admin/uploads.ts index 612db158b6..8dab2e3a82 100644 --- a/packages/medusa-js/src/resources/admin/uploads.ts +++ b/packages/medusa-js/src/resources/admin/uploads.ts @@ -1,13 +1,11 @@ import { AdminDeleteUploadsReq, - IAdminPostUploadsFileReq, AdminDeleteUploadsRes, AdminPostUploadsDownloadUrlReq, AdminUploadsDownloadUrlRes, AdminUploadsRes, } from "@medusajs/medusa" -import FormData from "form-data" -import { ResponsePromise } from "../../typings" +import { AdminCreateUploadPayload, ResponsePromise } from "../../typings" import BaseResource from "../base" class AdminUploadsResource extends BaseResource { @@ -15,20 +13,30 @@ class AdminUploadsResource extends BaseResource { "Content-Type": "multipart/form-data", } - create(file: IAdminPostUploadsFileReq): ResponsePromise { + /** + * @description Uploads at least one file to the specific fileservice that is installed in Medusa. + * @param file File or array of files to upload. + * @returns Uploaded file or files. + */ + create(file: AdminCreateUploadPayload): ResponsePromise { const path = `/admin/uploads` - const payload = new FormData() - payload.append("files", file) + const payload = this._createPayload(file) return this.client.request("POST", path, payload, {}, this.headers) } - - createProtected(file: IAdminPostUploadsFileReq): ResponsePromise { + + /** + * @description Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa. + * @param file File or array of files to upload. + * @returns Uploaded file or files. + */ + createProtected( + file: AdminCreateUploadPayload + ): ResponsePromise { const path = `/admin/uploads/protected` - const payload = new FormData() - payload.append("files", file) + const payload = this._createPayload(file) return this.client.request("POST", path, payload, {}, this.headers) } @@ -50,6 +58,18 @@ class AdminUploadsResource extends BaseResource { return this.client.request("POST", path, payload, {}, customHeaders) } + + private _createPayload(file: AdminCreateUploadPayload) { + const payload = new FormData() + + if (Array.isArray(file)) { + file.forEach((f) => payload.append("files", f)) + } else { + payload.append("files", file) + } + + return payload + } } export default AdminUploadsResource diff --git a/packages/medusa-js/src/typings.ts b/packages/medusa-js/src/typings.ts index 63f46f3a47..4e75906ff4 100644 --- a/packages/medusa-js/src/typings.ts +++ b/packages/medusa-js/src/typings.ts @@ -47,3 +47,5 @@ export type InviteUserRolesEnum = `${AdminPostInvitesReq["role"]}` export type AdminPostInvitesPayload = Omit & { role: InviteUserRolesEnum } + +export type AdminCreateUploadPayload = File | File[] diff --git a/packages/medusa-js/tsconfig.json b/packages/medusa-js/tsconfig.json index 4a45df0293..128bc71202 100644 --- a/packages/medusa-js/tsconfig.json +++ b/packages/medusa-js/tsconfig.json @@ -2,8 +2,7 @@ "compilerOptions": { "rootDir": "src", "module": "esnext", - "target": "es5", - "lib": ["es6", "dom", "es2016", "es2017"], + "target": "ES2015", "outDir": "./dist", "declarationDir": "./dist", "esModuleInterop": true, diff --git a/packages/medusa-js/tsup.config.ts b/packages/medusa-js/tsup.config.ts new file mode 100644 index 0000000000..df703de84a --- /dev/null +++ b/packages/medusa-js/tsup.config.ts @@ -0,0 +1,16 @@ +import type { Options } from "tsup" + +const config: Options = { + entry: ["src/**/*.ts"], + dts: true, + clean: true, + minify: true, + bundle: true, + sourcemap: true, + format: ["cjs", "esm"], + target: "es2020", + skipNodeModulesBundle: true, + tsconfig: "./tsconfig.json", +} + +export default config diff --git a/packages/medusa-react/src/contexts/medusa.tsx b/packages/medusa-react/src/contexts/medusa.tsx index 193839c42a..8caa1cd5c7 100644 --- a/packages/medusa-react/src/contexts/medusa.tsx +++ b/packages/medusa-react/src/contexts/medusa.tsx @@ -1,6 +1,6 @@ +import Medusa from "@medusajs/medusa-js" import React from "react" import { QueryClientProvider, QueryClientProviderProps } from "react-query" -import Medusa from "@medusajs/medusa-js" interface MedusaContextState { client: Medusa diff --git a/packages/medusa-react/src/hooks/admin/uploads/mutations.ts b/packages/medusa-react/src/hooks/admin/uploads/mutations.ts index ffd79eaa56..49a6adf8c3 100644 --- a/packages/medusa-react/src/hooks/admin/uploads/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/uploads/mutations.ts @@ -1,12 +1,11 @@ import { AdminDeleteUploadsReq, - IAdminPostUploadsFileReq, AdminDeleteUploadsRes, AdminPostUploadsDownloadUrlReq, AdminUploadsDownloadUrlRes, AdminUploadsRes, } from "@medusajs/medusa" -import { Response } from "@medusajs/medusa-js" +import { AdminCreateUploadPayload, Response } from "@medusajs/medusa-js" import { useMutation, UseMutationOptions, useQueryClient } from "react-query" import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" @@ -15,13 +14,13 @@ export const useAdminUploadFile = ( options?: UseMutationOptions< Response, Error, - IAdminPostUploadsFileReq + AdminCreateUploadPayload > ) => { const { client } = useMedusa() const queryClient = useQueryClient() - return useMutation((payload: IAdminPostUploadsFileReq) => { + return useMutation((payload: AdminCreateUploadPayload) => { return client.admin.uploads.create(payload) }, buildOptions(queryClient, undefined, options)) } @@ -30,13 +29,13 @@ export const useAdminUploadProtectedFile = ( options?: UseMutationOptions< Response, Error, - IAdminPostUploadsFileReq + AdminCreateUploadPayload > ) => { const { client } = useMedusa() const queryClient = useQueryClient() - return useMutation((payload: IAdminPostUploadsFileReq) => { + return useMutation((payload: AdminCreateUploadPayload) => { return client.admin.uploads.createProtected(payload) }, buildOptions(queryClient, undefined, options)) } diff --git a/yarn.lock b/yarn.lock index 6fcf7c35f9..bc1eca698f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2441,6 +2441,20 @@ __metadata: languageName: node linkType: hard +"@esbuild/android-arm@npm:0.15.18": + version: 0.15.18 + resolution: "@esbuild/android-arm@npm:0.15.18" + conditions: os=android & cpu=arm + languageName: node + linkType: hard + +"@esbuild/linux-loong64@npm:0.15.18": + version: 0.15.18 + resolution: "@esbuild/linux-loong64@npm:0.15.18" + conditions: os=linux & cpu=loong64 + languageName: node + linkType: hard + "@eslint/eslintrc@npm:^0.4.3": version: 0.4.3 resolution: "@eslint/eslintrc@npm:0.4.3" @@ -4141,7 +4155,7 @@ __metadata: languageName: node linkType: hard -"@jridgewell/sourcemap-codec@npm:^1.4.10, @jridgewell/sourcemap-codec@npm:^1.4.13": +"@jridgewell/sourcemap-codec@npm:^1.4.10": version: 1.4.14 resolution: "@jridgewell/sourcemap-codec@npm:1.4.14" checksum: 3fbaff1387c1338b097eeb6ff92890d7838f7de0dde259e4983763b44540bfd5ca6a1f7644dc8ad003a57f7e80670d5b96a8402f1386ba9aee074743ae9bad51 @@ -4398,19 +4412,16 @@ __metadata: resolution: "@medusajs/medusa-js@workspace:packages/medusa-js" dependencies: "@medusajs/medusa": ^1.7.3 - "@rollup/plugin-commonjs": ^24.0.0 - "@rollup/plugin-node-resolve": ^15.0.1 - "@types/jest": ^26.0.19 - axios: 0.26.1 + "@types/uuid": ^9.0.0 + axios: ^0.24.0 cross-env: ^7.0.3 - form-data: ^4.0.0 - jest: ^26.6.3 + jest: ^27.4.7 qs: ^6.10.3 retry-axios: ^2.6.0 - rollup: ^3.9.1 - rollup-plugin-terser: ^7.0.2 - rollup-plugin-typescript2: ^0.34.1 - typescript: ^4.1.3 + ts-jest: ^27.1.5 + tsup: ^6.5.0 + typescript: ^4.9.4 + uuid: ^9.0.0 peerDependencies: "@medusajs/medusa": ^1.7.3 languageName: unknown @@ -5581,25 +5592,6 @@ __metadata: languageName: node linkType: hard -"@rollup/plugin-commonjs@npm:^24.0.0": - version: 24.0.0 - resolution: "@rollup/plugin-commonjs@npm:24.0.0" - dependencies: - "@rollup/pluginutils": ^5.0.1 - commondir: ^1.0.1 - estree-walker: ^2.0.2 - glob: ^8.0.3 - is-reference: 1.2.1 - magic-string: ^0.27.0 - peerDependencies: - rollup: ^2.68.0||^3.0.0 - peerDependenciesMeta: - rollup: - optional: true - checksum: ae2ed1d49722fad55f7ef7629baad5fb31bc389e6042912fb5cb9623c2c9c0def27c66bbd1aea72f1fcd65caa1410a9de80a0377f85d8cd8068f97c0adeaf3da - languageName: node - linkType: hard - "@rollup/plugin-json@npm:^4.1.0": version: 4.1.0 resolution: "@rollup/plugin-json@npm:4.1.0" @@ -5643,25 +5635,6 @@ __metadata: languageName: node linkType: hard -"@rollup/plugin-node-resolve@npm:^15.0.1": - version: 15.0.1 - resolution: "@rollup/plugin-node-resolve@npm:15.0.1" - dependencies: - "@rollup/pluginutils": ^5.0.1 - "@types/resolve": 1.20.2 - deepmerge: ^4.2.2 - is-builtin-module: ^3.2.0 - is-module: ^1.0.0 - resolve: ^1.22.1 - peerDependencies: - rollup: ^2.78.0||^3.0.0 - peerDependenciesMeta: - rollup: - optional: true - checksum: 82af7876281e9459ea86cedf571816b61883055f98d3ecd9306e869674b344b5e38d57d589f409d255fe22021dd81f4a65702e9e8c859eded45bebccb8644e1b - languageName: node - linkType: hard - "@rollup/plugin-replace@npm:^3.1.0": version: 3.1.0 resolution: "@rollup/plugin-replace@npm:3.1.0" @@ -5697,22 +5670,6 @@ __metadata: languageName: node linkType: hard -"@rollup/pluginutils@npm:^5.0.1": - version: 5.0.2 - resolution: "@rollup/pluginutils@npm:5.0.2" - dependencies: - "@types/estree": ^1.0.0 - estree-walker: ^2.0.2 - picomatch: ^2.3.1 - peerDependencies: - rollup: ^1.20.0||^2.0.0||^3.0.0 - peerDependenciesMeta: - rollup: - optional: true - checksum: b06f73c15bb59418aa6fbfead5675bab2d6922e15663525ffc2eb8429530bc5add516600adb251cfbf9b60f3d12fb821cde155cb5103415154a476bd0f163432 - languageName: node - linkType: hard - "@segment/loosely-validate-event@npm:^2.0.0": version: 2.0.0 resolution: "@segment/loosely-validate-event@npm:2.0.0" @@ -7754,13 +7711,6 @@ __metadata: languageName: node linkType: hard -"@types/estree@npm:^1.0.0": - version: 1.0.0 - resolution: "@types/estree@npm:1.0.0" - checksum: 4e73ff606bf7c7ccdaa66092de650c410a4ad2ecc388fdbed8242cac9dbcad72407e1ceff041b7da691babb02ff74ab885d6231fb09368fdd1eabbf1b5253d49 - languageName: node - linkType: hard - "@types/express-serve-static-core@npm:^4.17.18": version: 4.17.29 resolution: "@types/express-serve-static-core@npm:4.17.29" @@ -7931,16 +7881,6 @@ __metadata: languageName: node linkType: hard -"@types/jest@npm:^26.0.19": - version: 26.0.24 - resolution: "@types/jest@npm:26.0.24" - dependencies: - jest-diff: ^26.0.0 - pretty-format: ^26.0.0 - checksum: 1085ac96af43566518daf3aca60cb7881bfe2ffe1f5343738933e386ebf909095fde15273c3e99c685854dfc833b05b156fb5daf68707c0daa1c0c0db13a665b - languageName: node - linkType: hard - "@types/jest@npm:^27.0.1, @types/jest@npm:^27.0.3, @types/jest@npm:^27.5.0, @types/jest@npm:^27.5.2": version: 27.5.2 resolution: "@types/jest@npm:27.5.2" @@ -8282,13 +8222,6 @@ __metadata: languageName: node linkType: hard -"@types/resolve@npm:1.20.2": - version: 1.20.2 - resolution: "@types/resolve@npm:1.20.2" - checksum: c5b7e1770feb5ccfb6802f6ad82a7b0d50874c99331e0c9b259e415e55a38d7a86ad0901c57665d93f75938be2a6a0bc9aa06c9749192cadb2e4512800bbc6e6 - languageName: node - linkType: hard - "@types/responselike@npm:*, @types/responselike@npm:^1.0.0": version: 1.0.0 resolution: "@types/responselike@npm:1.0.0" @@ -8436,6 +8369,13 @@ __metadata: languageName: node linkType: hard +"@types/uuid@npm:^9.0.0": + version: 9.0.0 + resolution: "@types/uuid@npm:9.0.0" + checksum: b0dc4582249b4efdbb6a9ebcd6acbcb864da14d558acfd5b17648972f8756e1a8e1de216a5e49a52b51d3804d56e60314467d9ac9450c8b90de138130021ed87 + languageName: node + linkType: hard + "@types/webpack-env@npm:^1.16.0": version: 1.17.0 resolution: "@types/webpack-env@npm:1.17.0" @@ -10441,15 +10381,6 @@ __metadata: languageName: node linkType: hard -"axios@npm:0.26.1, axios@npm:^0.26.0, axios@npm:^0.26.1": - version: 0.26.1 - resolution: "axios@npm:0.26.1" - dependencies: - follow-redirects: ^1.14.8 - checksum: 77ad7f1e6ca04fcd3fa8af1795b09d8b7c005b71a31f28d99ba40cda0bdcc12a4627801d7fac5efa62b9f667a8402bd54c669039694373bc8d44f6be611f785c - languageName: node - linkType: hard - "axios@npm:^0.19.0, axios@npm:^0.19.2": version: 0.19.2 resolution: "axios@npm:0.19.2" @@ -10486,6 +10417,15 @@ __metadata: languageName: node linkType: hard +"axios@npm:^0.26.0, axios@npm:^0.26.1": + version: 0.26.1 + resolution: "axios@npm:0.26.1" + dependencies: + follow-redirects: ^1.14.8 + checksum: 77ad7f1e6ca04fcd3fa8af1795b09d8b7c005b71a31f28d99ba40cda0bdcc12a4627801d7fac5efa62b9f667a8402bd54c669039694373bc8d44f6be611f785c + languageName: node + linkType: hard + "axobject-query@npm:^2.2.0": version: 2.2.0 resolution: "axobject-query@npm:2.2.0" @@ -11601,7 +11541,7 @@ __metadata: languageName: node linkType: hard -"builtin-modules@npm:^3.0.0, builtin-modules@npm:^3.1.0, builtin-modules@npm:^3.3.0": +"builtin-modules@npm:^3.0.0, builtin-modules@npm:^3.1.0": version: 3.3.0 resolution: "builtin-modules@npm:3.3.0" checksum: 2cb3448b4f7306dc853632a4fcddc95e8d4e4b9868c139400027b71938fc6806d4ff44007deffb362ac85724bd40c2c6452fb6a0aa4531650eeddb98d8e5ee8a @@ -11633,6 +11573,17 @@ __metadata: languageName: node linkType: hard +"bundle-require@npm:^3.1.2": + version: 3.1.2 + resolution: "bundle-require@npm:3.1.2" + dependencies: + load-tsconfig: ^0.2.0 + peerDependencies: + esbuild: ">=0.13" + checksum: 73f77df391a46f2cefc3bfc4777cd0169a47db1e69a64a16cb6a37208a03992ef68f02921e18ae4fba3387e076f37bcac8388077cba316ce9fd96105aec43f89 + languageName: node + linkType: hard + "bunyan@npm:1.8.15": version: 1.8.15 resolution: "bunyan@npm:1.8.15" @@ -11716,6 +11667,13 @@ __metadata: languageName: node linkType: hard +"cac@npm:^6.7.12": + version: 6.7.14 + resolution: "cac@npm:6.7.14" + checksum: 4ee06aaa7bab8981f0d54e5f5f9d4adcd64058e9697563ce336d8a3878ed018ee18ebe5359b2430eceae87e0758e62ea2019c3f52ae6e211b1bd2e133856cd10 + languageName: node + linkType: hard + "cacache@npm:^12.0.2": version: 12.0.4 resolution: "cacache@npm:12.0.4" @@ -12717,7 +12675,7 @@ __metadata: languageName: node linkType: hard -"commander@npm:^4.0.1, commander@npm:^4.1.1": +"commander@npm:^4.0.0, commander@npm:^4.0.1, commander@npm:^4.1.1": version: 4.1.1 resolution: "commander@npm:4.1.1" checksum: 84a76c08fe6cc08c9c93f62ac573d2907d8e79138999312c92d4155bc2325d487d64d13f669b2000c9f8caf70493c1be2dac74fec3c51d5a04f8bc3ae1830bab @@ -15192,6 +15150,223 @@ __metadata: languageName: node linkType: hard +"esbuild-android-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-android-64@npm:0.15.18" + conditions: os=android & cpu=x64 + languageName: node + linkType: hard + +"esbuild-android-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-android-arm64@npm:0.15.18" + conditions: os=android & cpu=arm64 + languageName: node + linkType: hard + +"esbuild-darwin-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-darwin-64@npm:0.15.18" + conditions: os=darwin & cpu=x64 + languageName: node + linkType: hard + +"esbuild-darwin-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-darwin-arm64@npm:0.15.18" + conditions: os=darwin & cpu=arm64 + languageName: node + linkType: hard + +"esbuild-freebsd-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-freebsd-64@npm:0.15.18" + conditions: os=freebsd & cpu=x64 + languageName: node + linkType: hard + +"esbuild-freebsd-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-freebsd-arm64@npm:0.15.18" + conditions: os=freebsd & cpu=arm64 + languageName: node + linkType: hard + +"esbuild-linux-32@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-32@npm:0.15.18" + conditions: os=linux & cpu=ia32 + languageName: node + linkType: hard + +"esbuild-linux-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-64@npm:0.15.18" + conditions: os=linux & cpu=x64 + languageName: node + linkType: hard + +"esbuild-linux-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-arm64@npm:0.15.18" + conditions: os=linux & cpu=arm64 + languageName: node + linkType: hard + +"esbuild-linux-arm@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-arm@npm:0.15.18" + conditions: os=linux & cpu=arm + languageName: node + linkType: hard + +"esbuild-linux-mips64le@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-mips64le@npm:0.15.18" + conditions: os=linux & cpu=mips64el + languageName: node + linkType: hard + +"esbuild-linux-ppc64le@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-ppc64le@npm:0.15.18" + conditions: os=linux & cpu=ppc64 + languageName: node + linkType: hard + +"esbuild-linux-riscv64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-riscv64@npm:0.15.18" + conditions: os=linux & cpu=riscv64 + languageName: node + linkType: hard + +"esbuild-linux-s390x@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-s390x@npm:0.15.18" + conditions: os=linux & cpu=s390x + languageName: node + linkType: hard + +"esbuild-netbsd-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-netbsd-64@npm:0.15.18" + conditions: os=netbsd & cpu=x64 + languageName: node + linkType: hard + +"esbuild-openbsd-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-openbsd-64@npm:0.15.18" + conditions: os=openbsd & cpu=x64 + languageName: node + linkType: hard + +"esbuild-sunos-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-sunos-64@npm:0.15.18" + conditions: os=sunos & cpu=x64 + languageName: node + linkType: hard + +"esbuild-windows-32@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-windows-32@npm:0.15.18" + conditions: os=win32 & cpu=ia32 + languageName: node + linkType: hard + +"esbuild-windows-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-windows-64@npm:0.15.18" + conditions: os=win32 & cpu=x64 + languageName: node + linkType: hard + +"esbuild-windows-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-windows-arm64@npm:0.15.18" + conditions: os=win32 & cpu=arm64 + languageName: node + linkType: hard + +"esbuild@npm:^0.15.1": + version: 0.15.18 + resolution: "esbuild@npm:0.15.18" + dependencies: + "@esbuild/android-arm": 0.15.18 + "@esbuild/linux-loong64": 0.15.18 + esbuild-android-64: 0.15.18 + esbuild-android-arm64: 0.15.18 + esbuild-darwin-64: 0.15.18 + esbuild-darwin-arm64: 0.15.18 + esbuild-freebsd-64: 0.15.18 + esbuild-freebsd-arm64: 0.15.18 + esbuild-linux-32: 0.15.18 + esbuild-linux-64: 0.15.18 + esbuild-linux-arm: 0.15.18 + esbuild-linux-arm64: 0.15.18 + esbuild-linux-mips64le: 0.15.18 + esbuild-linux-ppc64le: 0.15.18 + esbuild-linux-riscv64: 0.15.18 + esbuild-linux-s390x: 0.15.18 + esbuild-netbsd-64: 0.15.18 + esbuild-openbsd-64: 0.15.18 + esbuild-sunos-64: 0.15.18 + esbuild-windows-32: 0.15.18 + esbuild-windows-64: 0.15.18 + esbuild-windows-arm64: 0.15.18 + dependenciesMeta: + "@esbuild/android-arm": + optional: true + "@esbuild/linux-loong64": + optional: true + esbuild-android-64: + optional: true + esbuild-android-arm64: + optional: true + esbuild-darwin-64: + optional: true + esbuild-darwin-arm64: + optional: true + esbuild-freebsd-64: + optional: true + esbuild-freebsd-arm64: + optional: true + esbuild-linux-32: + optional: true + esbuild-linux-64: + optional: true + esbuild-linux-arm: + optional: true + esbuild-linux-arm64: + optional: true + esbuild-linux-mips64le: + optional: true + esbuild-linux-ppc64le: + optional: true + esbuild-linux-riscv64: + optional: true + esbuild-linux-s390x: + optional: true + esbuild-netbsd-64: + optional: true + esbuild-openbsd-64: + optional: true + esbuild-sunos-64: + optional: true + esbuild-windows-32: + optional: true + esbuild-windows-64: + optional: true + esbuild-windows-arm64: + optional: true + bin: + esbuild: bin/esbuild + checksum: 4eb13979ae2e52eab529b79a0f236e03d08a7bd90c46924d60af73ea4de32d819abf916d0fd7a12b4908f91297e1477739f3ea9c53a68fbcc47a08ab173c41b0 + languageName: node + linkType: hard + "escalade@npm:^3.1.1": version: 3.1.1 resolution: "escalade@npm:3.1.1" @@ -15935,7 +16110,7 @@ __metadata: languageName: node linkType: hard -"estree-walker@npm:^2.0.1, estree-walker@npm:^2.0.2": +"estree-walker@npm:^2.0.1": version: 2.0.2 resolution: "estree-walker@npm:2.0.2" checksum: 53a6c54e2019b8c914dc395890153ffdc2322781acf4bd7d1a32d7aedc1710807bdcd866ac133903d5629ec601fbb50abe8c2e5553c7f5a0afdd9b6af6c945af @@ -17082,7 +17257,7 @@ __metadata: languageName: node linkType: hard -"form-data@npm:4.0.0, form-data@npm:^4.0.0": +"form-data@npm:4.0.0": version: 4.0.0 resolution: "form-data@npm:4.0.0" dependencies: @@ -18163,6 +18338,20 @@ __metadata: languageName: node linkType: hard +"glob@npm:7.1.6": + version: 7.1.6 + resolution: "glob@npm:7.1.6" + dependencies: + fs.realpath: ^1.0.0 + inflight: ^1.0.4 + inherits: 2 + minimatch: ^3.0.4 + once: ^1.3.0 + path-is-absolute: ^1.0.0 + checksum: 2575cce9306ac534388db751f0aa3e78afedb6af8f3b529ac6b2354f66765545145dba8530abf7bff49fb399a047d3f9b6901c38ee4c9503f592960d9af67763 + languageName: node + linkType: hard + "glob@npm:^6.0.1": version: 6.0.4 resolution: "glob@npm:6.0.4" @@ -18190,7 +18379,7 @@ __metadata: languageName: node linkType: hard -"glob@npm:^8.0.1, glob@npm:^8.0.3": +"glob@npm:^8.0.1": version: 8.0.3 resolution: "glob@npm:8.0.3" dependencies: @@ -19853,15 +20042,6 @@ __metadata: languageName: node linkType: hard -"is-builtin-module@npm:^3.2.0": - version: 3.2.0 - resolution: "is-builtin-module@npm:3.2.0" - dependencies: - builtin-modules: ^3.3.0 - checksum: dd911ba5b5e9615d4da19fad3bbd839bcce8f279b28e094ff0883147a70e36fa4fd2d2aebc85886585106f8fc11d45ca60234afc4e3fa261ad58f013a26d3f1a - languageName: node - linkType: hard - "is-callable@npm:^1.1.3, is-callable@npm:^1.1.4, is-callable@npm:^1.2.4": version: 1.2.4 resolution: "is-callable@npm:1.2.4" @@ -20295,7 +20475,7 @@ __metadata: languageName: node linkType: hard -"is-reference@npm:1.2.1, is-reference@npm:^1.2.1": +"is-reference@npm:^1.2.1": version: 1.2.1 resolution: "is-reference@npm:1.2.1" dependencies: @@ -20966,7 +21146,7 @@ __metadata: languageName: node linkType: hard -"jest-diff@npm:^26.0.0, jest-diff@npm:^26.6.2": +"jest-diff@npm:^26.6.2": version: 26.6.2 resolution: "jest-diff@npm:26.6.2" dependencies: @@ -22143,6 +22323,13 @@ __metadata: languageName: node linkType: hard +"joycon@npm:^3.0.1": + version: 3.1.1 + resolution: "joycon@npm:3.1.1" + checksum: 131fb1e98c9065d067fd49b6e685487ac4ad4d254191d7aa2c9e3b90f4e9ca70430c43cad001602bdbdabcf58717d3b5c5b7461c1bd8e39478c8de706b3fe6ae + languageName: node + linkType: hard + "jpeg-js@npm:0.4.2": version: 0.4.2 resolution: "jpeg-js@npm:0.4.2" @@ -23009,6 +23196,13 @@ __metadata: languageName: node linkType: hard +"load-tsconfig@npm:^0.2.0": + version: 0.2.3 + resolution: "load-tsconfig@npm:0.2.3" + checksum: 82d0851020ecf8e226f328c0958cfbf5a34c8ffc7b04d396f25f53861e408c948866f2536123986a13ad9357c3cb2d2b90f51a04eb9474abbfef92399a6caa3d + languageName: node + linkType: hard + "load-yaml-file@npm:^0.2.0": version: 0.2.0 resolution: "load-yaml-file@npm:0.2.0" @@ -23595,15 +23789,6 @@ __metadata: languageName: node linkType: hard -"magic-string@npm:^0.27.0": - version: 0.27.0 - resolution: "magic-string@npm:0.27.0" - dependencies: - "@jridgewell/sourcemap-codec": ^1.4.13 - checksum: cddacfea14441ca57ae8a307bc3cf90bac69efaa4138dd9a80804cffc2759bf06f32da3a293fb13eaa96334b7d45b7768a34f1d226afae25d2f05b05a3bb37d8 - languageName: node - linkType: hard - "mailchimp-api-v3@npm:^1.14.0": version: 1.15.0 resolution: "mailchimp-api-v3@npm:1.15.0" @@ -25650,7 +25835,7 @@ __metadata: languageName: node linkType: hard -"mz@npm:^2.4.0": +"mz@npm:^2.4.0, mz@npm:^2.7.0": version: 2.7.0 resolution: "mz@npm:2.7.0" dependencies: @@ -27897,7 +28082,7 @@ __metadata: languageName: node linkType: hard -"postcss-load-config@npm:^3.0.0": +"postcss-load-config@npm:^3.0.0, postcss-load-config@npm:^3.0.1": version: 3.1.4 resolution: "postcss-load-config@npm:3.1.4" dependencies: @@ -28467,7 +28652,7 @@ __metadata: languageName: node linkType: hard -"pretty-format@npm:^26.0.0, pretty-format@npm:^26.6.2": +"pretty-format@npm:^26.6.2": version: 26.6.2 resolution: "pretty-format@npm:26.6.2" dependencies: @@ -30155,7 +30340,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:^1.1.6, resolve@npm:^1.10.0, resolve@npm:^1.12.0, resolve@npm:^1.14.2, resolve@npm:^1.17.0, resolve@npm:^1.18.1, resolve@npm:^1.19.0, resolve@npm:^1.20.0, resolve@npm:^1.22.0, resolve@npm:^1.22.1, resolve@npm:^1.3.2": +"resolve@npm:^1.1.6, resolve@npm:^1.10.0, resolve@npm:^1.12.0, resolve@npm:^1.14.2, resolve@npm:^1.17.0, resolve@npm:^1.18.1, resolve@npm:^1.19.0, resolve@npm:^1.20.0, resolve@npm:^1.22.0, resolve@npm:^1.3.2": version: 1.22.1 resolution: "resolve@npm:1.22.1" dependencies: @@ -30197,7 +30382,7 @@ __metadata: languageName: node linkType: hard -"resolve@patch:resolve@^1.1.6#~builtin, resolve@patch:resolve@^1.10.0#~builtin, resolve@patch:resolve@^1.12.0#~builtin, resolve@patch:resolve@^1.14.2#~builtin, resolve@patch:resolve@^1.17.0#~builtin, resolve@patch:resolve@^1.18.1#~builtin, resolve@patch:resolve@^1.19.0#~builtin, resolve@patch:resolve@^1.20.0#~builtin, resolve@patch:resolve@^1.22.0#~builtin, resolve@patch:resolve@^1.22.1#~builtin, resolve@patch:resolve@^1.3.2#~builtin": +"resolve@patch:resolve@^1.1.6#~builtin, resolve@patch:resolve@^1.10.0#~builtin, resolve@patch:resolve@^1.12.0#~builtin, resolve@patch:resolve@^1.14.2#~builtin, resolve@patch:resolve@^1.17.0#~builtin, resolve@patch:resolve@^1.18.1#~builtin, resolve@patch:resolve@^1.19.0#~builtin, resolve@patch:resolve@^1.20.0#~builtin, resolve@patch:resolve@^1.22.0#~builtin, resolve@patch:resolve@^1.3.2#~builtin": version: 1.22.1 resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin::version=1.22.1&hash=07638b" dependencies: @@ -30472,22 +30657,6 @@ __metadata: languageName: node linkType: hard -"rollup-plugin-typescript2@npm:^0.34.1": - version: 0.34.1 - resolution: "rollup-plugin-typescript2@npm:0.34.1" - dependencies: - "@rollup/pluginutils": ^4.1.2 - find-cache-dir: ^3.3.2 - fs-extra: ^10.0.0 - semver: ^7.3.7 - tslib: ^2.4.0 - peerDependencies: - rollup: ">=1.26.3" - typescript: ">=2.4.0" - checksum: 957171f167e6bbefab68bd05ed2796aafd14c8d47bf544b92532bcea056b5a63fe300816a428c49361736160b2ffc7e8b1109bf4fa9de95e54a9fdd161e0bf62 - languageName: node - linkType: hard - "rollup-pluginutils@npm:^2.8.2": version: 2.8.2 resolution: "rollup-pluginutils@npm:2.8.2" @@ -30511,9 +30680,9 @@ __metadata: languageName: node linkType: hard -"rollup@npm:^3.9.1": - version: 3.9.1 - resolution: "rollup@npm:3.9.1" +"rollup@npm:^3.2.5": + version: 3.10.0 + resolution: "rollup@npm:3.10.0" dependencies: fsevents: ~2.3.2 dependenciesMeta: @@ -30521,7 +30690,7 @@ __metadata: optional: true bin: rollup: dist/bin/rollup - checksum: 48875f9414b17dda1f3a8eea3a2cfffbe847451f986e0c4f6363f06cde05d508730f29486d3f25f27db28dc76bb411a23959b826b1054d3848bab0d84a471fdd + checksum: 2803c8142865de4d5f68267a6e8810d2dff0a5414927b936773b7c27504ab7302c5ada1f85b0871de26a1e6d10363bdc2928fddcd3d55bb93c2c2570f704f8f6 languageName: node linkType: hard @@ -31706,6 +31875,15 @@ __metadata: languageName: node linkType: hard +"source-map@npm:0.8.0-beta.0": + version: 0.8.0-beta.0 + resolution: "source-map@npm:0.8.0-beta.0" + dependencies: + whatwg-url: ^7.0.0 + checksum: fb4d9bde9a9fdb2c29b10e5eae6c71d10e09ef467e1afb75fdec2eb7e11fa5b343a2af553f74f18b695dbc0b81f9da2e9fa3d7a317d5985e9939499ec6087835 + languageName: node + linkType: hard + "source-map@npm:^0.5.0, source-map@npm:^0.5.6, source-map@npm:^0.5.7": version: 0.5.7 resolution: "source-map@npm:0.5.7" @@ -32536,6 +32714,23 @@ __metadata: languageName: node linkType: hard +"sucrase@npm:^3.20.3": + version: 3.29.0 + resolution: "sucrase@npm:3.29.0" + dependencies: + commander: ^4.0.0 + glob: 7.1.6 + lines-and-columns: ^1.1.6 + mz: ^2.7.0 + pirates: ^4.0.1 + ts-interface-checker: ^0.1.9 + bin: + sucrase: bin/sucrase + sucrase-node: bin/sucrase-node + checksum: 4932ca76122f1f0cbd19f864265ce7c95652723994cf5a5c73b7b2bdef8d9b9257ba65085f61760e83cb8624d18b2fa309fe901dba77169264f4eb6a2e12719c + languageName: node + linkType: hard + "sudo-prompt@npm:^8.2.0": version: 8.2.5 resolution: "sudo-prompt@npm:8.2.5" @@ -33287,6 +33482,15 @@ __metadata: languageName: node linkType: hard +"tree-kill@npm:^1.2.2": + version: 1.2.2 + resolution: "tree-kill@npm:1.2.2" + bin: + tree-kill: cli.js + checksum: 7b1b7c7f17608a8f8d20a162e7957ac1ef6cd1636db1aba92f4e072dc31818c2ff0efac1e3d91064ede67ed5dc57c565420531a8134090a12ac10cf792ab14d2 + languageName: node + linkType: hard + "trim-newlines@npm:^1.0.0": version: 1.0.0 resolution: "trim-newlines@npm:1.0.0" @@ -33350,6 +33554,13 @@ __metadata: languageName: node linkType: hard +"ts-interface-checker@npm:^0.1.9": + version: 0.1.13 + resolution: "ts-interface-checker@npm:0.1.13" + checksum: 232509f1b84192d07b81d1e9b9677088e590ac1303436da1e92b296e9be8e31ea042e3e1fd3d29b1742ad2c959e95afe30f63117b8f1bc3a3850070a5142fea7 + languageName: node + linkType: hard + "ts-jest@npm:^25.5.1": version: 25.5.1 resolution: "ts-jest@npm:25.5.1" @@ -33621,6 +33832,42 @@ __metadata: languageName: node linkType: hard +"tsup@npm:^6.5.0": + version: 6.5.0 + resolution: "tsup@npm:6.5.0" + dependencies: + bundle-require: ^3.1.2 + cac: ^6.7.12 + chokidar: ^3.5.1 + debug: ^4.3.1 + esbuild: ^0.15.1 + execa: ^5.0.0 + globby: ^11.0.3 + joycon: ^3.0.1 + postcss-load-config: ^3.0.1 + resolve-from: ^5.0.0 + rollup: ^3.2.5 + source-map: 0.8.0-beta.0 + sucrase: ^3.20.3 + tree-kill: ^1.2.2 + peerDependencies: + "@swc/core": ^1 + postcss: ^8.4.12 + typescript: ^4.1.0 + peerDependenciesMeta: + "@swc/core": + optional: true + postcss: + optional: true + typescript: + optional: true + bin: + tsup: dist/cli-default.js + tsup-node: dist/cli-node.js + checksum: 6372a480db2dca02bb10ff27b888114d4347ce4c635ae95a7d558be0e5e23ff81373389bcce98c3086136527b63590b02f3000e266d0cb8be0fcdca6119e716e + languageName: node + linkType: hard + "tsutils@npm:^3.21.0": version: 3.21.0 resolution: "tsutils@npm:3.21.0" @@ -34041,6 +34288,16 @@ __metadata: languageName: node linkType: hard +"typescript@npm:^4.9.4": + version: 4.9.4 + resolution: "typescript@npm:4.9.4" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: 5008b97a2a3afdbe57ea70e504ebc8ec98f18d888059dfb7932a41f566a1360a28afc8de2a440fd6143b4014cc6d2616079931dc690c7513c2d21fa53957e0ec + languageName: node + linkType: hard + "typescript@patch:typescript@^4.1.3#~builtin, typescript@patch:typescript@^4.4.4#~builtin, typescript@patch:typescript@^4.5.2#~builtin, typescript@patch:typescript@^4.5.5#~builtin": version: 4.7.4 resolution: "typescript@patch:typescript@npm%3A4.7.4#~builtin::version=4.7.4&hash=7ad353" @@ -34051,6 +34308,16 @@ __metadata: languageName: node linkType: hard +"typescript@patch:typescript@^4.9.4#~builtin": + version: 4.9.4 + resolution: "typescript@patch:typescript@npm%3A4.9.4#~builtin::version=4.9.4&hash=7ad353" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: b8cba6ab3ee30218578663352bcd74220ef20c42544fd1cc1382f24dee385002e784702b176c451da9c14c39965c035815902ef43b06eeefd5faae18ee700cea + languageName: node + linkType: hard + "ua-parser-js@npm:^0.7.30": version: 0.7.31 resolution: "ua-parser-js@npm:0.7.31" @@ -34702,6 +34969,15 @@ __metadata: languageName: node linkType: hard +"uuid@npm:^9.0.0": + version: 9.0.0 + resolution: "uuid@npm:9.0.0" + bin: + uuid: dist/bin/uuid + checksum: 8867e438990d1d33ac61093e2e4e3477a2148b844e4fa9e3c2360fa4399292429c4b6ec64537eb1659c97b2d10db349c673ad58b50e2824a11e0d3630de3c056 + languageName: node + linkType: hard + "v8-compile-cache-lib@npm:^3.0.1": version: 3.0.1 resolution: "v8-compile-cache-lib@npm:3.0.1" From 31daa964a7f8438cc1bf66635ee6ecab194f77c8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 17 Jan 2023 09:55:22 +0200 Subject: [PATCH 13/14] chore(docs): Removed Docs Announcement Bar (automated) (#3048) Co-authored-by: shahednasser --- www/docs/announcement.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/docs/announcement.json b/www/docs/announcement.json index 2136f7f2cb..9e26dfeeb6 100644 --- a/www/docs/announcement.json +++ b/www/docs/announcement.json @@ -1 +1 @@ -{"id":"https://github.com/medusajs/medusa/releases/tag/v1.7.3","content":"v1.7.3 is out","isCloseable":true} \ No newline at end of file +{} \ No newline at end of file From 107cd4de4ca3c8cf30dcb576b911eac65da692a8 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 17 Jan 2023 10:38:13 +0200 Subject: [PATCH 14/14] docs: fixed note about custom database schema (#3049) --- docs/content/usage/configurations.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/content/usage/configurations.md b/docs/content/usage/configurations.md index 55f0e1de10..884a71a16c 100644 --- a/docs/content/usage/configurations.md +++ b/docs/content/usage/configurations.md @@ -72,15 +72,12 @@ module.exports = { // ...other configurations database_type: "postgres", database_url: DATABASE_URL, - database_schema: process.env.DATABASE_SCHEMA, // optional }, } ``` Where `database_type` is `postgres` and `DATABASE_URL` is the URL connection string to your PostgreSQL database. You can check out how to format it in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html). -You can optionally set the `database_schema` option. By default, its value is `public`. When you set the `database_schema` option, you must add the `search_path` option to the database URL. For example, the value of `database_url` is `postgres://localhost/store?options=-c search_path=test` if `database_schema` is `test`. - It's recommended to set the Database URL as an environment variable: ```bash @@ -89,6 +86,16 @@ DATABASE_URL= Where `` is the URL of your PostgreSQL database. +### Changing PostgreSQL Schema + +By default, the `public` schema is used in PostgreSQL. You can change it to use a custom schema by passing the `search_path` option in the database URL. For example: + +```bash +postgres://localhost/store?options=-c search_path=test +``` + +Where `test` is the name of the database schema that should be used instead of `public`. + ### Changing Database Type Remember to run migrations after you change your database type to `postgres` from another type: