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

chore(docs): Generated References (#6896)

Browse Source 
Generated the following references:
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax_calculation`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-04-01 13:35:12 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 9fdced2c27
commit 68aa0971a2
947 changed files with 12121 additions and 3688 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/modules/medusa.mdx
+79 -20
View File
@@ -16,12 +16,33 @@ import TypeList from "@site/src/components/TypeList"
- [PostgresError](../medusa/enums/medusa.PostgresError.mdx)
- [MODULE\_RESOURCE\_TYPE](../medusa/enums/medusa.MODULE_RESOURCE_TYPE.mdx)
- [ProductStatus](../medusa/enums/medusa.ProductStatus.mdx)
- [TransactionHandlerType](../medusa/enums/medusa.TransactionHandlerType.mdx)
- [PriceListStatus](../medusa/enums/medusa.PriceListStatus-1.mdx)
- [PriceListType](../medusa/enums/medusa.PriceListType-1.mdx)
- [PromotionType](../medusa/enums/medusa.PromotionType.mdx)
- [ApplicationMethodType](../medusa/enums/medusa.ApplicationMethodType.mdx)
- [ApplicationMethodTargetType](../medusa/enums/medusa.ApplicationMethodTargetType.mdx)
- [ApplicationMethodAllocation](../medusa/enums/medusa.ApplicationMethodAllocation.mdx)
- [PromotionRuleOperator](../medusa/enums/medusa.PromotionRuleOperator.mdx)
- [CampaignBudgetType](../medusa/enums/medusa.CampaignBudgetType.mdx)
## Classes
- [MedusaError](../medusa/classes/medusa.MedusaError.mdx)
- [AdminPostCampaignsReq](../medusa/classes/medusa.AdminPostCampaignsReq.mdx)
- [IdObject](../medusa/classes/medusa.IdObject.mdx)
- [CampaignBudget](../medusa/classes/medusa.CampaignBudget.mdx)
- [AdminGetPromotionsPromotionParams](../medusa/classes/medusa.AdminGetPromotionsPromotionParams.mdx)
- [AdminGetPromotionsParams](../medusa/classes/medusa.AdminGetPromotionsParams.mdx)
- [AdminPostPromotionsReq](../medusa/classes/medusa.AdminPostPromotionsReq.mdx)
- [PromotionRule](../medusa/classes/medusa.PromotionRule.mdx)
- [ApplicationMethodsPostReq](../medusa/classes/medusa.ApplicationMethodsPostReq.mdx)
- [ApplicationMethodsMethodPostReq](../medusa/classes/medusa.ApplicationMethodsMethodPostReq.mdx)
- [AdminPostPromotionsPromotionReq](../medusa/classes/medusa.AdminPostPromotionsPromotionReq.mdx)
- [AdminPostPromotionsPromotionRulesBatchAddReq](../medusa/classes/medusa.AdminPostPromotionsPromotionRulesBatchAddReq.mdx)
- [AdminPostPromotionsPromotionRulesBatchRemoveReq](../medusa/classes/medusa.AdminPostPromotionsPromotionRulesBatchRemoveReq.mdx)
- [AdminPostPromotionsPromotionRulesBatchUpdateReq](../medusa/classes/medusa.AdminPostPromotionsPromotionRulesBatchUpdateReq.mdx)
- [UpdatePromotionRule](../medusa/classes/medusa.UpdatePromotionRule.mdx)
- [AdminPostAnalyticsConfigReq](../medusa/classes/medusa.AdminPostAnalyticsConfigReq.mdx)
- [AdminPostAnalyticsConfigAnalyticsConfigReq](../medusa/classes/medusa.AdminPostAnalyticsConfigAnalyticsConfigReq.mdx)
- [AdminPostAuthReq](../medusa/classes/medusa.AdminPostAuthReq.mdx)
@@ -50,8 +71,8 @@ import TypeList from "@site/src/components/TypeList"
- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx)
- [AdminPostDiscountsDiscountConditions](../medusa/classes/medusa.AdminPostDiscountsDiscountConditions.mdx)
- [AdminPostDiscountsDiscountConditionsParams](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsParams.mdx)
- [AdminPostDiscountsReq](../medusa/classes/medusa.AdminPostDiscountsReq.mdx)
- [AdminPostDiscountsDiscountRule](../medusa/classes/medusa.AdminPostDiscountsDiscountRule.mdx)
- [AdminPostDiscountsReq](../medusa/classes/medusa.AdminPostDiscountsReq.mdx)
- [AdminCreateCondition](../medusa/classes/medusa.AdminCreateCondition.mdx)
- [AdminPostDiscountsParams](../medusa/classes/medusa.AdminPostDiscountsParams.mdx)
- [AdminPostDiscountsDiscountDynamicCodesReq](../medusa/classes/medusa.AdminPostDiscountsDiscountDynamicCodesReq.mdx)
@@ -64,8 +85,8 @@ import TypeList from "@site/src/components/TypeList"
- [AdminGetDiscountsParams](../medusa/classes/medusa.AdminGetDiscountsParams.mdx)
- [AdminPostDiscountsDiscountConditionsCondition](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsCondition.mdx)
- [AdminPostDiscountsDiscountConditionsConditionParams](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionParams.mdx)
- [AdminPostDiscountsDiscountReq](../medusa/classes/medusa.AdminPostDiscountsDiscountReq.mdx)
- [AdminUpdateDiscountRule](../medusa/classes/medusa.AdminUpdateDiscountRule.mdx)
- [AdminPostDiscountsDiscountReq](../medusa/classes/medusa.AdminPostDiscountsDiscountReq.mdx)
- [AdminUpsertCondition](../medusa/classes/medusa.AdminUpsertCondition.mdx)
- [AdminPostDiscountsDiscountParams](../medusa/classes/medusa.AdminPostDiscountsDiscountParams.mdx)
- [AdminPostDraftOrdersReq](../medusa/classes/medusa.AdminPostDraftOrdersReq.mdx)
@@ -119,11 +140,11 @@ import TypeList from "@site/src/components/TypeList"
- [AdminPostOrdersOrderCompleteParams](../medusa/classes/medusa.AdminPostOrdersOrderCompleteParams.mdx)
- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx)
- [AdminPostOrdersOrderClaimsClaimShipmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsParams.mdx)
- [AdminPostOrdersOrderClaimsReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsReq.mdx)
- [ReturnShipping](../medusa/classes/medusa.ReturnShipping.mdx)
- [ShippingMethod](../medusa/classes/medusa.ShippingMethod-1.mdx)
- [Item](../medusa/classes/medusa.Item-1.mdx)
- [AdditionalItem](../medusa/classes/medusa.AdditionalItem.mdx)
- [AdminPostOrdersOrderClaimsReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsReq.mdx)
- [AdminPostOrdersOrderClaimsParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsParams.mdx)
- [AdminPostOrdersOrderFulfillmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderFulfillmentsReq.mdx)
- [Item](../medusa/classes/medusa.Item-2.mdx)
@@ -132,11 +153,11 @@ import TypeList from "@site/src/components/TypeList"
- [AdminPostOrdersOrderShipmentParams](../medusa/classes/medusa.AdminPostOrdersOrderShipmentParams.mdx)
- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx)
- [AdminPostOrdersOrderSwapsSwapShipmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsParams.mdx)
- [AdminPostOrdersOrderSwapsReq](../medusa/classes/medusa.AdminPostOrdersOrderSwapsReq.mdx)
- [ReturnItem](../medusa/classes/medusa.ReturnItem.mdx)
- [ReturnShipping](../medusa/classes/medusa.ReturnShipping-1.mdx)
- [CustomShippingOption](../medusa/classes/medusa.CustomShippingOption.mdx)
- [AdditionalItem](../medusa/classes/medusa.AdditionalItem-1.mdx)
- [AdminPostOrdersOrderSwapsReq](../medusa/classes/medusa.AdminPostOrdersOrderSwapsReq.mdx)
- [AdminPostOrdersOrderSwapsParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapsParams.mdx)
- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx)
- [AdminPostOrdersOrderClaimsClaimFulfillmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.mdx)
@@ -147,8 +168,8 @@ import TypeList from "@site/src/components/TypeList"
- [AdminPostOrdersOrderSwapsSwapProcessPaymentParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.mdx)
- [AdminPostOrdersOrderRefundsReq](../medusa/classes/medusa.AdminPostOrdersOrderRefundsReq.mdx)
- [AdminPostOrdersOrderRefundsParams](../medusa/classes/medusa.AdminPostOrdersOrderRefundsParams.mdx)
- [AdminPostOrdersOrderReturnsReq](../medusa/classes/medusa.AdminPostOrdersOrderReturnsReq.mdx)
- [ReturnShipping](../medusa/classes/medusa.ReturnShipping-2.mdx)
- [AdminPostOrdersOrderReturnsReq](../medusa/classes/medusa.AdminPostOrdersOrderReturnsReq.mdx)
- [AdminPostOrdersOrderReturnsParams](../medusa/classes/medusa.AdminPostOrdersOrderReturnsParams.mdx)
- [AdminPostOrdersOrderClaimsClaimReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimReq.mdx)
- [ShippingMethod](../medusa/classes/medusa.ShippingMethod-2.mdx)
@@ -156,9 +177,9 @@ import TypeList from "@site/src/components/TypeList"
- [Image](../medusa/classes/medusa.Image.mdx)
- [Tag](../medusa/classes/medusa.Tag.mdx)
- [AdminPostOrdersOrderClaimsClaimParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimParams.mdx)
- [AdminPostOrdersOrderReq](../medusa/classes/medusa.AdminPostOrdersOrderReq.mdx)
- [PaymentMethod](../medusa/classes/medusa.PaymentMethod.mdx)
- [ShippingMethod](../medusa/classes/medusa.ShippingMethod-3.mdx)
- [AdminPostOrdersOrderReq](../medusa/classes/medusa.AdminPostOrdersOrderReq.mdx)
- [AdminPostOrdersOrderParams](../medusa/classes/medusa.AdminPostOrdersOrderParams.mdx)
- [AdminGetPaymentCollectionsParams](../medusa/classes/medusa.AdminGetPaymentCollectionsParams.mdx)
- [AdminUpdatePaymentCollectionsReq](../medusa/classes/medusa.AdminUpdatePaymentCollectionsReq.mdx)
@@ -277,6 +298,10 @@ import TypeList from "@site/src/components/TypeList"
- [AdminUpdateUserRequest](../medusa/classes/medusa.AdminUpdateUserRequest.mdx)
- [AdminGetVariantParams](../medusa/classes/medusa.AdminGetVariantParams.mdx)
- [AdminGetVariantsParams](../medusa/classes/medusa.AdminGetVariantsParams.mdx)
- [AdminGetWorkflowExecutionDetailsParams](../medusa/classes/medusa.AdminGetWorkflowExecutionDetailsParams.mdx)
- [AdminGetWorkflowExecutionsParams](../medusa/classes/medusa.AdminGetWorkflowExecutionsParams.mdx)
- [AdminPostWorkflowsRunReq](../medusa/classes/medusa.AdminPostWorkflowsRunReq.mdx)
- [AdminPostWorkflowsAsyncResponseReq](../medusa/classes/medusa.AdminPostWorkflowsAsyncResponseReq.mdx)
- [StorePostAuthReq](../medusa/classes/medusa.StorePostAuthReq.mdx)
- [StorePostCartsCartShippingMethodReq](../medusa/classes/medusa.StorePostCartsCartShippingMethodReq.mdx)
- [Item](../medusa/classes/medusa.Item-5.mdx)
@@ -392,7 +417,10 @@ import TypeList from "@site/src/components/TypeList"
- [PaginatedResponse](../medusa/interfaces/medusa.PaginatedResponse.mdx)
- [DeleteResponse](../medusa/interfaces/medusa.DeleteResponse.mdx)
- [MedusaRequest](../medusa/interfaces/medusa.MedusaRequest.mdx)
- [AuthenticatedMedusaRequest](../medusa/interfaces/medusa.AuthenticatedMedusaRequest.mdx)
- [SubscriberContext](../medusa/interfaces/medusa.SubscriberContext.mdx)
- [RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields-1.mdx)
- [PaginatedResponse](../medusa/interfaces/medusa.PaginatedResponse-1.mdx)
- [SessionOptions](../medusa/interfaces/medusa.SessionOptions.mdx)
- [HttpCompressionOptions](../medusa/interfaces/medusa.HttpCompressionOptions.mdx)
- [ProjectConfigOptions](../medusa/interfaces/medusa.ProjectConfigOptions.mdx)
@@ -412,13 +440,21 @@ import TypeList from "@site/src/components/TypeList"
- [ProductCollectionDTO](../medusa/interfaces/medusa.ProductCollectionDTO.mdx)
- [ProductTypeDTO](../medusa/interfaces/medusa.ProductTypeDTO.mdx)
- [ProductOptionDTO](../medusa/interfaces/medusa.ProductOptionDTO.mdx)
- [ProductVariantOptionDTO](../medusa/interfaces/medusa.ProductVariantOptionDTO.mdx)
- [ProductImageDTO](../medusa/interfaces/medusa.ProductImageDTO.mdx)
- [ProductOptionValueDTO](../medusa/interfaces/medusa.ProductOptionValueDTO.mdx)
- [ApplicationMethodDTO](../medusa/interfaces/medusa.ApplicationMethodDTO.mdx)
- [CampaignBudgetDTO](../medusa/interfaces/medusa.CampaignBudgetDTO.mdx)
- [CampaignDTO](../medusa/interfaces/medusa.CampaignDTO.mdx)
- [PromotionRuleValueDTO](../medusa/interfaces/medusa.PromotionRuleValueDTO.mdx)
- [PromotionRuleDTO](../medusa/interfaces/medusa.PromotionRuleDTO.mdx)
- [PromotionDTO](../medusa/interfaces/medusa.PromotionDTO.mdx)
- [ITransactionBaseService](../medusa/interfaces/medusa.ITransactionBaseService.mdx)
## Type Aliases
- [MedusaContainer](../medusa/types/medusa.MedusaContainer.mdx)
- [AdminPromotionsListRes](../medusa/types/medusa.AdminPromotionsListRes.mdx)
- [handler](../medusa/types/medusa.handler.mdx)
- [AdminAnalyticsConfigRes](../medusa/types/medusa.AdminAnalyticsConfigRes.mdx)
- [AdminAnalyticsConfigDeleteRes](../medusa/types/medusa.AdminAnalyticsConfigDeleteRes.mdx)
@@ -594,6 +630,7 @@ import TypeList from "@site/src/components/TypeList"
- [MiddlewareVerb](../medusa/types/medusa.MiddlewareVerb.mdx)
- [MiddlewareFunction](../medusa/types/medusa.MiddlewareFunction.mdx)
- [MedusaErrorHandlerFunction](../medusa/types/medusa.MedusaErrorHandlerFunction.mdx)
- [ParserConfigArgs](../medusa/types/medusa.ParserConfigArgs.mdx)
- [ParserConfig](../medusa/types/medusa.ParserConfig.mdx)
- [MiddlewareRoute](../medusa/types/medusa.MiddlewareRoute.mdx)
- [MiddlewaresConfig](../medusa/types/medusa.MiddlewaresConfig.mdx)
@@ -612,6 +649,7 @@ import TypeList from "@site/src/components/TypeList"
- [Selector](../medusa/types/medusa.Selector.mdx)
- [TotalField](../medusa/types/medusa.TotalField.mdx)
- [QueryConfig](../medusa/types/medusa.QueryConfig.mdx)
- [DraftOrderStatusValue](../medusa/types/medusa.DraftOrderStatusValue.mdx)
- [FeatureFlagsResponse](../medusa/types/medusa.FeatureFlagsResponse.mdx)
- [CreateReturnType](../medusa/types/medusa.CreateReturnType.mdx)
- [ExtendedRequest](../medusa/types/medusa.ExtendedRequest.mdx)
@@ -648,7 +686,6 @@ import TypeList from "@site/src/components/TypeList"
- [GiftCardAllocation](../medusa/types/medusa.GiftCardAllocation.mdx)
- [DiscountAllocation](../medusa/types/medusa.DiscountAllocation.mdx)
- [LineAllocationsMap](../medusa/types/medusa.LineAllocationsMap.mdx)
- [PaginatedResponse](../medusa/types/medusa.PaginatedResponse-1.mdx)
- [DeleteResponse](../medusa/types/medusa.DeleteResponse-1.mdx)
- [MedusaContainer](../medusa/types/medusa.MedusaContainer-2.mdx)
- [InventoryItemDTO](../medusa/types/medusa.InventoryItemDTO.mdx)
@@ -665,6 +702,12 @@ import TypeList from "@site/src/components/TypeList"
- [ModuleJoinerConfig](../medusa/types/medusa.ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](../medusa/types/medusa.ModuleJoinerRelationship.mdx)
- [ModuleExports](../medusa/types/medusa.ModuleExports.mdx)
- [ApplicationMethodTypeValues](../medusa/types/medusa.ApplicationMethodTypeValues.mdx)
- [ApplicationMethodTargetTypeValues](../medusa/types/medusa.ApplicationMethodTargetTypeValues.mdx)
- [ApplicationMethodAllocationValues](../medusa/types/medusa.ApplicationMethodAllocationValues.mdx)
- [CampaignBudgetTypeValues](../medusa/types/medusa.CampaignBudgetTypeValues.mdx)
- [PromotionRuleOperatorValues](../medusa/types/medusa.PromotionRuleOperatorValues.mdx)
- [PromotionTypeValues](../medusa/types/medusa.PromotionTypeValues.mdx)
- [StockLocationAddressDTO](../medusa/types/medusa.StockLocationAddressDTO.mdx)
- [StockLocationDTO](../medusa/types/medusa.StockLocationDTO.mdx)
- [StockLocationExpandedDTO](../medusa/types/medusa.StockLocationExpandedDTO.mdx)
@@ -799,14 +842,6 @@ ___
`Const` **defaultPaymentFields**: `string`[]
### defaultAdminPriceListRemoteQueryObject
`Const` **defaultAdminPriceListRemoteQueryObject**: `Object`
#### Properties
<TypeList types={[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rules","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"price_list_rule_values","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"price_set_money_amounts","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"money_amount","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_rules","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"variant_link","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="defaultAdminPriceListRemoteQueryObject"/>
### defaultAdminPriceListFields
`Const` **defaultAdminPriceListFields**: `string`[]
@@ -855,6 +890,10 @@ ___
`Const` **defaultAdminGetProductsVariantsFields**: `string`[]
### defaultAdminGetProductsVariantsRelations
`Const` **defaultAdminGetProductsVariantsRelations**: `string`[]
### defaultAdminProductRemoteQueryObject
`Const` **defaultAdminProductRemoteQueryObject**: `Object`
@@ -961,6 +1000,22 @@ This is temporary.
`Const` **defaultAdminVariantFields**: keyof [ProductVariant](../entities/classes/entities.ProductVariant.mdx)[]
### defaultAdminWorkflowExecutionsRelations
`Const` **defaultAdminWorkflowExecutionsRelations**: `never`[] = `[]`
### allowedAdminWorkflowExecutionsRelations
`Const` **allowedAdminWorkflowExecutionsRelations**: `never`[] = `[]`
### defaultAdminWorkflowExecutionsFields
`Const` **defaultAdminWorkflowExecutionsFields**: `string`[]
### defaultAdminWorkflowExecutionDetailFields
`Const` **defaultAdminWorkflowExecutionDetailFields**: `string`[]
### defaultStoreCartFields
`Const` **defaultStoreCartFields**: keyof [Cart](../entities/classes/entities.Cart.mdx)[] = `[]`
@@ -1313,11 +1368,11 @@ Middleware that transform the query input for the admin end points
#### Type Parameters
<TypeList types={[{"name":"T","type":"[RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TEntity","type":"`BaseEntity`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformQuery"/>
<TypeList types={[{"name":"T","type":"[RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TEntity","type":"`BaseEntity`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformQuery"/>
#### Parameters
<TypeList types={[{"name":"plainToClass","type":"[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`ValidatorOptions`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"queryConfig","type":"Omit&#60;[QueryConfig](../medusa/types/medusa.QueryConfig.mdx)&#60;TEntity&#62;, \"allowedFields\" \\| \"allowedRelations\"&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"defaultFields","type":"(keyof TEntity \\| `string`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultLimit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="transformQuery"/>
<TypeList types={[{"name":"plainToClass","type":"[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"queryConfig","type":"[QueryConfig](../medusa/types/medusa.QueryConfig.mdx)&#60;TEntity&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"defaults","type":"(keyof TEntity \\| `string`)[]","description":"Default fields and relations to return","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultFields","type":"(keyof TEntity \\| `string`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"Fields and relations that are allowed to be requested","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultLimit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"config","type":"`ValidatorOptions`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} sectionTitle="transformQuery"/>
#### Returns
@@ -1337,11 +1392,11 @@ Middleware that transform the query input for the store endpoints
#### Type Parameters
<TypeList types={[{"name":"T","type":"[RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TEntity","type":"`BaseEntity`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformStoreQuery"/>
<TypeList types={[{"name":"T","type":"[RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TEntity","type":"`BaseEntity`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformStoreQuery"/>
#### Parameters
<TypeList types={[{"name":"plainToClass","type":"[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`ValidatorOptions`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"queryConfig","type":"[QueryConfig](../medusa/types/medusa.QueryConfig.mdx)&#60;TEntity&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"defaultFields","type":"(keyof TEntity \\| `string`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultLimit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="transformStoreQuery"/>
<TypeList types={[{"name":"plainToClass","type":"[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`ValidatorOptions`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"queryConfig","type":"[QueryConfig](../medusa/types/medusa.QueryConfig.mdx)&#60;TEntity&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"defaults","type":"(keyof TEntity \\| `string`)[]","description":"Default fields and relations to return","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultFields","type":"(keyof TEntity \\| `string`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"Fields and relations that are allowed to be requested","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultLimit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="transformStoreQuery"/>
#### Returns
@@ -1355,6 +1410,10 @@ Middleware that transform the query input for the store endpoints
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
#### Deprecated
use `transformQuery` instead
### reserveQuantityForDraftOrder
#### Parameters
@@ -1419,7 +1478,7 @@ Middleware that transform the query input for the store endpoints
#### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__namedParameters.limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="extendedFindParamsMixin"/>
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__namedParameters.limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="extendedFindParamsMixin"/>
#### Returns