chore: reorganize docs apps (#7228)

* reorganize docs apps * add README * fix directory * add condition for old docs
2024-05-03 17:36:38 +03:00
1 parent 224ebb2154
commit 4fe28f5a95
@@ -0,0 +1,31 @@
+import { TypeList } from "docs-ui"
+
+# api-key
+
+## Interfaces
+
+- [ApiKeyDTO](../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)
+- [FilterableApiKeyProps](../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)
+- [CreateApiKeyDTO](../../api_key/interfaces/api_key.CreateApiKeyDTO/page.mdx)
+- [UpsertApiKeyDTO](../../api_key/interfaces/api_key.UpsertApiKeyDTO/page.mdx)
+- [UpdateApiKeyDTO](../../api_key/interfaces/api_key.UpdateApiKeyDTO/page.mdx)
+- [RevokeApiKeyDTO](../../api_key/interfaces/api_key.RevokeApiKeyDTO/page.mdx)
+- [IApiKeyModuleService](../../api_key/interfaces/api_key.IApiKeyModuleService/page.mdx)
+- [FindConfig](../../api_key/interfaces/api_key.FindConfig/page.mdx)
+- [BaseFilterable](../../api_key/interfaces/api_key.BaseFilterable/page.mdx)
+- [JoinerServiceConfigAlias](../../api_key/interfaces/api_key.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../api_key/interfaces/api_key.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../api_key/interfaces/api_key.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../api_key/interfaces/api_key.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../api_key/interfaces/api_key.IMessageAggregator/page.mdx)
+- [Context](../../api_key/interfaces/api_key.Context/page.mdx)
+
+## Type Aliases
+
+- [ApiKeyType](../../api_key/types/api_key.ApiKeyType/page.mdx)
+- [MessageBody](../../api_key/types/api_key.MessageBody/page.mdx)
+- [Message](../../api_key/types/api_key.Message/page.mdx)
+- [MessageFormat](../../api_key/types/api_key.MessageFormat/page.mdx)
+- [JoinerRelationship](../../api_key/types/api_key.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../api_key/types/api_key.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../api_key/types/api_key.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,14 @@
+---
+displayed_sidebar: apiKeyModelReference
+slug: /references/api-key/models
+---
+
+import { TypeList } from "docs-ui"
+
+# API Key Module Data Models Reference
+
+This documentation provides a reference to the data models in the API Key Module
+
+## Classes
+
+- [ApiKey](../../api_key_models/classes/api_key_models.ApiKey/page.mdx)
@@ -0,0 +1,30 @@
+import { TypeList } from "docs-ui"
+
+# auth
+
+## Interfaces
+
+- [AuthUserDTO](../../auth/interfaces/auth.AuthUserDTO/page.mdx)
+- [CreateAuthUserDTO](../../auth/interfaces/auth.CreateAuthUserDTO/page.mdx)
+- [UpdateAuthUserDTO](../../auth/interfaces/auth.UpdateAuthUserDTO/page.mdx)
+- [FilterableAuthUserProps](../../auth/interfaces/auth.FilterableAuthUserProps/page.mdx)
+- [AuthenticationResponse](../../auth/interfaces/auth.AuthenticationResponse/page.mdx)
+- [AuthenticationInput](../../auth/interfaces/auth.AuthenticationInput/page.mdx)
+- [IAuthModuleService](../../auth/interfaces/auth.IAuthModuleService/page.mdx)
+- [FindConfig](../../auth/interfaces/auth.FindConfig/page.mdx)
+- [BaseFilterable](../../auth/interfaces/auth.BaseFilterable/page.mdx)
+- [JoinerServiceConfigAlias](../../auth/interfaces/auth.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../auth/interfaces/auth.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../auth/interfaces/auth.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../auth/interfaces/auth.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../auth/interfaces/auth.IMessageAggregator/page.mdx)
+- [Context](../../auth/interfaces/auth.Context/page.mdx)
+
+## Type Aliases
+
+- [MessageBody](../../auth/types/auth.MessageBody/page.mdx)
+- [Message](../../auth/types/auth.Message/page.mdx)
+- [MessageFormat](../../auth/types/auth.MessageFormat/page.mdx)
+- [JoinerRelationship](../../auth/types/auth.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../auth/types/auth.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../auth/types/auth.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,14 @@
+---
+displayed_sidebar: authModelReference
+slug: /references/auth/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Auth Module Data Models Reference
+
+This documentation provides a reference to the data models in the Auth Module
+
+## Classes
+
+- [AuthUser](../../auth_models/classes/auth_models.AuthUser/page.mdx)
@@ -0,0 +1,82 @@
+import { TypeList } from "docs-ui"
+
+# cart
+
+## Interfaces
+
+- [AdjustmentLineDTO](../../cart/interfaces/cart.AdjustmentLineDTO/page.mdx)
+- [ShippingMethodAdjustmentDTO](../../cart/interfaces/cart.ShippingMethodAdjustmentDTO/page.mdx)
+- [LineItemAdjustmentDTO](../../cart/interfaces/cart.LineItemAdjustmentDTO/page.mdx)
+- [TaxLineDTO](../../cart/interfaces/cart.TaxLineDTO/page.mdx)
+- [ShippingMethodTaxLineDTO](../../cart/interfaces/cart.ShippingMethodTaxLineDTO/page.mdx)
+- [LineItemTaxLineDTO](../../cart/interfaces/cart.LineItemTaxLineDTO/page.mdx)
+- [CartAddressDTO](../../cart/interfaces/cart.CartAddressDTO/page.mdx)
+- [CartShippingMethodDTO](../../cart/interfaces/cart.CartShippingMethodDTO/page.mdx)
+- [CartLineItemTotalsDTO](../../cart/interfaces/cart.CartLineItemTotalsDTO/page.mdx)
+- [CartLineItemDTO](../../cart/interfaces/cart.CartLineItemDTO/page.mdx)
+- [CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx)
+- [FilterableCartProps](../../cart/interfaces/cart.FilterableCartProps/page.mdx)
+- [FilterableAddressProps](../../cart/interfaces/cart.FilterableAddressProps/page.mdx)
+- [FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)
+- [FilterableLineItemAdjustmentProps](../../cart/interfaces/cart.FilterableLineItemAdjustmentProps/page.mdx)
+- [FilterableShippingMethodProps](../../cart/interfaces/cart.FilterableShippingMethodProps/page.mdx)
+- [FilterableShippingMethodAdjustmentProps](../../cart/interfaces/cart.FilterableShippingMethodAdjustmentProps/page.mdx)
+- [FilterableLineItemTaxLineProps](../../cart/interfaces/cart.FilterableLineItemTaxLineProps/page.mdx)
+- [FilterableShippingMethodTaxLineProps](../../cart/interfaces/cart.FilterableShippingMethodTaxLineProps/page.mdx)
+- [UpsertAddressDTO](../../cart/interfaces/cart.UpsertAddressDTO/page.mdx)
+- [UpdateAddressDTO](../../cart/interfaces/cart.UpdateAddressDTO/page.mdx)
+- [CreateAddressDTO](../../cart/interfaces/cart.CreateAddressDTO/page.mdx)
+- [CreateCartDTO](../../cart/interfaces/cart.CreateCartDTO/page.mdx)
+- [UpdateCartDataDTO](../../cart/interfaces/cart.UpdateCartDataDTO/page.mdx)
+- [UpdateCartDTO](../../cart/interfaces/cart.UpdateCartDTO/page.mdx)
+- [CreateAdjustmentDTO](../../cart/interfaces/cart.CreateAdjustmentDTO/page.mdx)
+- [UpdateAdjustmentDTO](../../cart/interfaces/cart.UpdateAdjustmentDTO/page.mdx)
+- [CreateLineItemAdjustmentDTO](../../cart/interfaces/cart.CreateLineItemAdjustmentDTO/page.mdx)
+- [UpsertLineItemAdjustmentDTO](../../cart/interfaces/cart.UpsertLineItemAdjustmentDTO/page.mdx)
+- [CreateTaxLineDTO](../../cart/interfaces/cart.CreateTaxLineDTO/page.mdx)
+- [UpdateTaxLineDTO](../../cart/interfaces/cart.UpdateTaxLineDTO/page.mdx)
+- [CreateShippingMethodTaxLineDTO](../../cart/interfaces/cart.CreateShippingMethodTaxLineDTO/page.mdx)
+- [UpdateShippingMethodTaxLineDTO](../../cart/interfaces/cart.UpdateShippingMethodTaxLineDTO/page.mdx)
+- [CreateLineItemTaxLineDTO](../../cart/interfaces/cart.CreateLineItemTaxLineDTO/page.mdx)
+- [UpdateLineItemTaxLineDTO](../../cart/interfaces/cart.UpdateLineItemTaxLineDTO/page.mdx)
+- [CreateLineItemDTO](../../cart/interfaces/cart.CreateLineItemDTO/page.mdx)
+- [CreateLineItemForCartDTO](../../cart/interfaces/cart.CreateLineItemForCartDTO/page.mdx)
+- [UpdateLineItemWithSelectorDTO](../../cart/interfaces/cart.UpdateLineItemWithSelectorDTO/page.mdx)
+- [UpdateLineItemDTO](../../cart/interfaces/cart.UpdateLineItemDTO/page.mdx)
+- [CreateShippingMethodDTO](../../cart/interfaces/cart.CreateShippingMethodDTO/page.mdx)
+- [CreateShippingMethodForSingleCartDTO](../../cart/interfaces/cart.CreateShippingMethodForSingleCartDTO/page.mdx)
+- [CreateShippingMethodAdjustmentDTO](../../cart/interfaces/cart.CreateShippingMethodAdjustmentDTO/page.mdx)
+- [UpdateShippingMethodAdjustmentDTO](../../cart/interfaces/cart.UpdateShippingMethodAdjustmentDTO/page.mdx)
+- [ICartModuleService](../../cart/interfaces/cart.ICartModuleService/page.mdx)
+- [FindConfig](../../cart/interfaces/cart.FindConfig/page.mdx)
+- [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../cart/interfaces/cart.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../cart/interfaces/cart.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../cart/interfaces/cart.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../cart/interfaces/cart.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../cart/interfaces/cart.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../cart/interfaces/cart.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../cart/interfaces/cart.IMessageAggregator/page.mdx)
+- [Context](../../cart/interfaces/cart.Context/page.mdx)
+
+## Type Aliases
+
+- [Query](../../cart/types/cart.Query/page.mdx)
+- [ExpandScalar](../../cart/types/cart.ExpandScalar/page.mdx)
+- [Scalar](../../cart/types/cart.Scalar/page.mdx)
+- [ReadonlyPrimary](../../cart/types/cart.ReadonlyPrimary/page.mdx)
+- [Primary](../../cart/types/cart.Primary/page.mdx)
+- [OperatorMap](../../cart/types/cart.OperatorMap/page.mdx)
+- [FilterValue2](../../cart/types/cart.FilterValue2/page.mdx)
+- [FilterValue](../../cart/types/cart.FilterValue/page.mdx)
+- [PrevLimit](../../cart/types/cart.PrevLimit/page.mdx)
+- [FilterQuery](../../cart/types/cart.FilterQuery/page.mdx)
+- [MessageBody](../../cart/types/cart.MessageBody/page.mdx)
+- [Message](../../cart/types/cart.Message/page.mdx)
+- [MessageFormat](../../cart/types/cart.MessageFormat/page.mdx)
+- [JoinerRelationship](../../cart/types/cart.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../cart/types/cart.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../cart/types/cart.ModuleJoinerRelationship/page.mdx)
+- [BigNumberRawValue](../../cart/types/cart.BigNumberRawValue/page.mdx)
+- [BigNumberInput](../../cart/types/cart.BigNumberInput/page.mdx)
+- [BigNumberValue](../../cart/types/cart.BigNumberValue/page.mdx)
@@ -0,0 +1,35 @@
+---
+displayed_sidebar: cartModelReference
+slug: /references/cart/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Cart Module Data Models Reference
+
+This documentation provides a reference to the data models in the Cart Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	Cart }|--|{ Address : shipping_address
+	Cart ||--|| LineItem : items
+	Cart ||--|| ShippingMethod : shipping_methods
+	LineItem ||--|| LineItemTaxLine : tax_lines
+	LineItem ||--|| LineItemAdjustment : adjustments
+	ShippingMethod ||--|| ShippingMethodTaxLine : tax_lines
+	ShippingMethod ||--|| ShippingMethodAdjustment : adjustments
+
+```
+
+## Classes
+
+- [Address](../../cart_models/classes/cart_models.Address/page.mdx)
+- [Cart](../../cart_models/classes/cart_models.Cart/page.mdx)
+- [LineItemAdjustment](../../cart_models/classes/cart_models.LineItemAdjustment/page.mdx)
+- [LineItemTaxLine](../../cart_models/classes/cart_models.LineItemTaxLine/page.mdx)
+- [LineItem](../../cart_models/classes/cart_models.LineItem/page.mdx)
+- [ShippingMethodAdjustment](../../cart_models/classes/cart_models.ShippingMethodAdjustment/page.mdx)
+- [ShippingMethodTaxLine](../../cart_models/classes/cart_models.ShippingMethodTaxLine/page.mdx)
+- [ShippingMethod](../../cart_models/classes/cart_models.ShippingMethod/page.mdx)
@@ -0,0 +1,26 @@
+import { TypeList } from "docs-ui"
+
+# currency
+
+## Interfaces
+
+- [FindConfig](../../currency/interfaces/currency.FindConfig/page.mdx)
+- [CurrencyDTO](../../currency/interfaces/currency.CurrencyDTO/page.mdx)
+- [FilterableCurrencyProps](../../currency/interfaces/currency.FilterableCurrencyProps/page.mdx)
+- [ICurrencyModuleService](../../currency/interfaces/currency.ICurrencyModuleService/page.mdx)
+- [BaseFilterable](../../currency/interfaces/currency.BaseFilterable/page.mdx)
+- [JoinerServiceConfigAlias](../../currency/interfaces/currency.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../currency/interfaces/currency.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../currency/interfaces/currency.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../currency/interfaces/currency.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../currency/interfaces/currency.IMessageAggregator/page.mdx)
+- [Context](../../currency/interfaces/currency.Context/page.mdx)
+
+## Type Aliases
+
+- [MessageBody](../../currency/types/currency.MessageBody/page.mdx)
+- [Message](../../currency/types/currency.Message/page.mdx)
+- [MessageFormat](../../currency/types/currency.MessageFormat/page.mdx)
+- [JoinerRelationship](../../currency/types/currency.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../currency/types/currency.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../currency/types/currency.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,14 @@
+---
+displayed_sidebar: currencyModelReference
+slug: /references/currency/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Currency Module Data Models Reference
+
+This documentation provides a reference to the data models in the Currency Module
+
+## Classes
+
+- [Currency](../../currency_models/classes/currency_models.Currency/page.mdx)
@@ -0,0 +1,51 @@
+import { TypeList } from "docs-ui"
+
+# customer
+
+## Interfaces
+
+- [FindConfig](../../customer/interfaces/customer.FindConfig/page.mdx)
+- [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)
+- [FilterableCustomerAddressProps](../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)
+- [FilterableCustomerGroupProps](../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)
+- [FilterableCustomerGroupCustomerProps](../../customer/interfaces/customer.FilterableCustomerGroupCustomerProps/page.mdx)
+- [FilterableCustomerProps](../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)
+- [CustomerGroupDTO](../../customer/interfaces/customer.CustomerGroupDTO/page.mdx)
+- [CustomerGroupCustomerDTO](../../customer/interfaces/customer.CustomerGroupCustomerDTO/page.mdx)
+- [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)
+- [GroupCustomerPair](../../customer/interfaces/customer.GroupCustomerPair/page.mdx)
+- [CreateCustomerAddressDTO](../../customer/interfaces/customer.CreateCustomerAddressDTO/page.mdx)
+- [UpdateCustomerAddressDTO](../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)
+- [CreateCustomerDTO](../../customer/interfaces/customer.CreateCustomerDTO/page.mdx)
+- [CustomerUpdatableFields](../../customer/interfaces/customer.CustomerUpdatableFields/page.mdx)
+- [CustomerGroupUpdatableFields](../../customer/interfaces/customer.CustomerGroupUpdatableFields/page.mdx)
+- [CreateCustomerGroupDTO](../../customer/interfaces/customer.CreateCustomerGroupDTO/page.mdx)
+- [ICustomerModuleService](../../customer/interfaces/customer.ICustomerModuleService/page.mdx)
+- [BaseFilterable](../../customer/interfaces/customer.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../customer/interfaces/customer.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../customer/interfaces/customer.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../customer/interfaces/customer.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../customer/interfaces/customer.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../customer/interfaces/customer.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../customer/interfaces/customer.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../customer/interfaces/customer.IMessageAggregator/page.mdx)
+- [Context](../../customer/interfaces/customer.Context/page.mdx)
+
+## Type Aliases
+
+- [Query](../../customer/types/customer.Query/page.mdx)
+- [ExpandScalar](../../customer/types/customer.ExpandScalar/page.mdx)
+- [Scalar](../../customer/types/customer.Scalar/page.mdx)
+- [ReadonlyPrimary](../../customer/types/customer.ReadonlyPrimary/page.mdx)
+- [Primary](../../customer/types/customer.Primary/page.mdx)
+- [OperatorMap](../../customer/types/customer.OperatorMap/page.mdx)
+- [FilterValue2](../../customer/types/customer.FilterValue2/page.mdx)
+- [FilterValue](../../customer/types/customer.FilterValue/page.mdx)
+- [PrevLimit](../../customer/types/customer.PrevLimit/page.mdx)
+- [FilterQuery](../../customer/types/customer.FilterQuery/page.mdx)
+- [MessageBody](../../customer/types/customer.MessageBody/page.mdx)
+- [Message](../../customer/types/customer.Message/page.mdx)
+- [MessageFormat](../../customer/types/customer.MessageFormat/page.mdx)
+- [JoinerRelationship](../../customer/types/customer.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../customer/types/customer.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../customer/types/customer.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,28 @@
+---
+displayed_sidebar: customerModelReference
+slug: /references/customer/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Customer Module Data Models Reference
+
+This documentation provides a reference to the data models in the Customer Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	Address }|--|{ Customer : customer
+	Customer }|--|{ CustomerGroup : groups
+	CustomerGroupCustomer }|--|{ Customer : customer
+	CustomerGroupCustomer }|--|{ CustomerGroup : customer_group
+
+```
+
+## Classes
+
+- [Address](../../customer_models/classes/customer_models.Address/page.mdx)
+- [CustomerGroupCustomer](../../customer_models/classes/customer_models.CustomerGroupCustomer/page.mdx)
+- [CustomerGroup](../../customer_models/classes/customer_models.CustomerGroup/page.mdx)
+- [Customer](../../customer_models/classes/customer_models.Customer/page.mdx)
@@ -0,0 +1,11 @@
+import { TypeList } from "docs-ui"
+
+# file
+
+## Classes
+
+- [AbstractFileService](../../file/classes/file.AbstractFileService/page.mdx)
+
+## Interfaces
+
+- [IFileService](../../file/interfaces/file.IFileService/page.mdx)
@@ -0,0 +1,92 @@
+import { TypeList } from "docs-ui"
+
+# fulfillment
+
+## Interfaces
+
+- [FindConfig](../../fulfillment/interfaces/fulfillment.FindConfig/page.mdx)
+- [BaseFilterable](../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../fulfillment/interfaces/fulfillment.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../fulfillment/interfaces/fulfillment.RestoreReturn/page.mdx)
+- [FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)
+- [FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)
+- [FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)
+- [FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)
+- [FilterableFulfillmentProviderProps](../../fulfillment/interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)
+- [FulfillmentSetDTO](../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)
+- [FilterableFulfillmentSetProps](../../fulfillment/interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)
+- [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)
+- [FilterableFulfillmentProps](../../fulfillment/interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)
+- [GeoZoneDTO](../../fulfillment/interfaces/fulfillment.GeoZoneDTO/page.mdx)
+- [FilterableGeoZoneProps](../../fulfillment/interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)
+- [ServiceZoneDTO](../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)
+- [FilterableServiceZoneProps](../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)
+- [ShippingOptionRuleDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx)
+- [FilterableShippingOptionRuleProps](../../fulfillment/interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)
+- [ShippingOptionTypeDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionTypeDTO/page.mdx)
+- [FilterableShippingOptionTypeProps](../../fulfillment/interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)
+- [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)
+- [FilterableShippingOptionProps](../../fulfillment/interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)
+- [FilterableShippingOptionForContextProps](../../fulfillment/interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)
+- [ShippingProfileDTO](../../fulfillment/interfaces/fulfillment.ShippingProfileDTO/page.mdx)
+- [FilterableShippingProfileProps](../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)
+- [CreateFulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.CreateFulfillmentAddressDTO/page.mdx)
+- [CreateFulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.CreateFulfillmentItemDTO/page.mdx)
+- [CreateFulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.CreateFulfillmentLabelDTO/page.mdx)
+- [CreateFulfillmentSetDTO](../../fulfillment/interfaces/fulfillment.CreateFulfillmentSetDTO/page.mdx)
+- [UpdateFulfillmentSetDTO](../../fulfillment/interfaces/fulfillment.UpdateFulfillmentSetDTO/page.mdx)
+- [CreateFulfillmentOrderDTO](../../fulfillment/interfaces/fulfillment.CreateFulfillmentOrderDTO/page.mdx)
+- [CreateFulfillmentDTO](../../fulfillment/interfaces/fulfillment.CreateFulfillmentDTO/page.mdx)
+- [UpdateFulfillmentDTO](../../fulfillment/interfaces/fulfillment.UpdateFulfillmentDTO/page.mdx)
+- [CreateGeoZoneBaseDTO](../../fulfillment/interfaces/fulfillment.CreateGeoZoneBaseDTO/page.mdx)
+- [CreateCountryGeoZoneDTO](../../fulfillment/interfaces/fulfillment.CreateCountryGeoZoneDTO/page.mdx)
+- [CreateProvinceGeoZoneDTO](../../fulfillment/interfaces/fulfillment.CreateProvinceGeoZoneDTO/page.mdx)
+- [CreateCityGeoZoneDTO](../../fulfillment/interfaces/fulfillment.CreateCityGeoZoneDTO/page.mdx)
+- [CreateZipGeoZoneDTO](../../fulfillment/interfaces/fulfillment.CreateZipGeoZoneDTO/page.mdx)
+- [UpdateGeoZoneBaseDTO](../../fulfillment/interfaces/fulfillment.UpdateGeoZoneBaseDTO/page.mdx)
+- [UpdateCountryGeoZoneDTO](../../fulfillment/interfaces/fulfillment.UpdateCountryGeoZoneDTO/page.mdx)
+- [UpdateProvinceGeoZoneDTO](../../fulfillment/interfaces/fulfillment.UpdateProvinceGeoZoneDTO/page.mdx)
+- [UpdateCityGeoZoneDTO](../../fulfillment/interfaces/fulfillment.UpdateCityGeoZoneDTO/page.mdx)
+- [UpdateZipGeoZoneDTO](../../fulfillment/interfaces/fulfillment.UpdateZipGeoZoneDTO/page.mdx)
+- [CreateServiceZoneDTO](../../fulfillment/interfaces/fulfillment.CreateServiceZoneDTO/page.mdx)
+- [UpdateServiceZoneDTO](../../fulfillment/interfaces/fulfillment.UpdateServiceZoneDTO/page.mdx)
+- [UpsertServiceZoneDTO](../../fulfillment/interfaces/fulfillment.UpsertServiceZoneDTO/page.mdx)
+- [CreateShippingOptionRuleDTO](../../fulfillment/interfaces/fulfillment.CreateShippingOptionRuleDTO/page.mdx)
+- [UpdateShippingOptionRuleDTO](../../fulfillment/interfaces/fulfillment.UpdateShippingOptionRuleDTO/page.mdx)
+- [CreateShippingOptionTypeDTO](../../fulfillment/interfaces/fulfillment.CreateShippingOptionTypeDTO/page.mdx)
+- [CreateShippingOptionDTO](../../fulfillment/interfaces/fulfillment.CreateShippingOptionDTO/page.mdx)
+- [UpdateShippingOptionDTO](../../fulfillment/interfaces/fulfillment.UpdateShippingOptionDTO/page.mdx)
+- [UpsertShippingOptionDTO](../../fulfillment/interfaces/fulfillment.UpsertShippingOptionDTO/page.mdx)
+- [CreateShippingProfileDTO](../../fulfillment/interfaces/fulfillment.CreateShippingProfileDTO/page.mdx)
+- [UpdateShippingProfileDTO](../../fulfillment/interfaces/fulfillment.UpdateShippingProfileDTO/page.mdx)
+- [IFulfillmentModuleService](../../fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx)
+- [JoinerServiceConfigAlias](../../fulfillment/interfaces/fulfillment.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../fulfillment/interfaces/fulfillment.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../fulfillment/interfaces/fulfillment.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../fulfillment/interfaces/fulfillment.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../fulfillment/interfaces/fulfillment.IMessageAggregator/page.mdx)
+- [Context](../../fulfillment/interfaces/fulfillment.Context/page.mdx)
+
+## Type Aliases
+
+- [RuleOperatorType](../../fulfillment/types/fulfillment.RuleOperatorType/page.mdx)
+- [Query](../../fulfillment/types/fulfillment.Query/page.mdx)
+- [ExpandScalar](../../fulfillment/types/fulfillment.ExpandScalar/page.mdx)
+- [Scalar](../../fulfillment/types/fulfillment.Scalar/page.mdx)
+- [ReadonlyPrimary](../../fulfillment/types/fulfillment.ReadonlyPrimary/page.mdx)
+- [Primary](../../fulfillment/types/fulfillment.Primary/page.mdx)
+- [OperatorMap](../../fulfillment/types/fulfillment.OperatorMap/page.mdx)
+- [FilterValue2](../../fulfillment/types/fulfillment.FilterValue2/page.mdx)
+- [FilterValue](../../fulfillment/types/fulfillment.FilterValue/page.mdx)
+- [PrevLimit](../../fulfillment/types/fulfillment.PrevLimit/page.mdx)
+- [FilterQuery](../../fulfillment/types/fulfillment.FilterQuery/page.mdx)
+- [MessageBody](../../fulfillment/types/fulfillment.MessageBody/page.mdx)
+- [Message](../../fulfillment/types/fulfillment.Message/page.mdx)
+- [MessageFormat](../../fulfillment/types/fulfillment.MessageFormat/page.mdx)
+- [GeoZoneType](../../fulfillment/types/fulfillment.GeoZoneType/page.mdx)
+- [ShippingOptionPriceType](../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)
+- [CreateGeoZoneDTO](../../fulfillment/types/fulfillment.CreateGeoZoneDTO/page.mdx)
+- [UpdateGeoZoneDTO](../../fulfillment/types/fulfillment.UpdateGeoZoneDTO/page.mdx)
+- [JoinerRelationship](../../fulfillment/types/fulfillment.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../fulfillment/types/fulfillment.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../fulfillment/types/fulfillment.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,44 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the data models in the Fulfillment Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	Fulfillment }|--|{ ShippingOption : shipping_option
+	Fulfillment }|--|{ FulfillmentProvider : provider
+	Fulfillment ||--|| Address : delivery_address
+	Fulfillment ||--|| FulfillmentItem : items
+	Fulfillment ||--|| FulfillmentLabel : labels
+	FulfillmentSet ||--|| ServiceZone : service_zones
+	GeoZone }|--|{ ServiceZone : service_zone
+	ServiceZone ||--|| ShippingOption : shipping_options
+	ShippingOption }|--|{ ShippingProfile : shipping_profile
+	ShippingOption }|--|{ FulfillmentProvider : provider
+	ShippingOption ||--|| ShippingOptionType : type
+	ShippingOption ||--|| ShippingOptionRule : rules
+
+```
+
+## Classes
+
+- [Address](../../fulfillment_models/classes/fulfillment_models.Address/page.mdx)
+- [FulfillmentItem](../../fulfillment_models/classes/fulfillment_models.FulfillmentItem/page.mdx)
+- [FulfillmentLabel](../../fulfillment_models/classes/fulfillment_models.FulfillmentLabel/page.mdx)
+- [FulfillmentProvider](../../fulfillment_models/classes/fulfillment_models.FulfillmentProvider/page.mdx)
+- [FulfillmentSet](../../fulfillment_models/classes/fulfillment_models.FulfillmentSet/page.mdx)
+- [Fulfillment](../../fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx)
+- [GeoZone](../../fulfillment_models/classes/fulfillment_models.GeoZone/page.mdx)
+- [ServiceZone](../../fulfillment_models/classes/fulfillment_models.ServiceZone/page.mdx)
+- [ShippingOptionRule](../../fulfillment_models/classes/fulfillment_models.ShippingOptionRule/page.mdx)
+- [ShippingOptionType](../../fulfillment_models/classes/fulfillment_models.ShippingOptionType/page.mdx)
+- [ShippingOption](../../fulfillment_models/classes/fulfillment_models.ShippingOption/page.mdx)
+- [ShippingProfile](../../fulfillment_models/classes/fulfillment_models.ShippingProfile/page.mdx)
@@ -0,0 +1,50 @@
+import { TypeList } from "docs-ui"
+
+# inventory-next
+
+## Interfaces
+
+- [FindConfig](../../inventory_next/interfaces/inventory_next.FindConfig/page.mdx)
+- [StringComparisonOperator](../../inventory_next/interfaces/inventory_next.StringComparisonOperator/page.mdx)
+- [NumericalComparisonOperator](../../inventory_next/interfaces/inventory_next.NumericalComparisonOperator/page.mdx)
+- [BaseFilterable](../../inventory_next/interfaces/inventory_next.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../inventory_next/interfaces/inventory_next.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../inventory_next/interfaces/inventory_next.RestoreReturn/page.mdx)
+- [InventoryItemDTO](../../inventory_next/interfaces/inventory_next.InventoryItemDTO/page.mdx)
+- [FilterableInventoryItemProps](../../inventory_next/interfaces/inventory_next.FilterableInventoryItemProps/page.mdx)
+- [InventoryLevelDTO](../../inventory_next/interfaces/inventory_next.InventoryLevelDTO/page.mdx)
+- [FilterableInventoryLevelProps](../../inventory_next/interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx)
+- [ReservationItemDTO](../../inventory_next/interfaces/inventory_next.ReservationItemDTO/page.mdx)
+- [FilterableReservationItemProps](../../inventory_next/interfaces/inventory_next.FilterableReservationItemProps/page.mdx)
+- [UpdateInventoryItemInput](../../inventory_next/interfaces/inventory_next.UpdateInventoryItemInput/page.mdx)
+- [CreateInventoryItemInput](../../inventory_next/interfaces/inventory_next.CreateInventoryItemInput/page.mdx)
+- [CreateInventoryLevelInput](../../inventory_next/interfaces/inventory_next.CreateInventoryLevelInput/page.mdx)
+- [BulkUpdateInventoryLevelInput](../../inventory_next/interfaces/inventory_next.BulkUpdateInventoryLevelInput/page.mdx)
+- [UpdateReservationItemInput](../../inventory_next/interfaces/inventory_next.UpdateReservationItemInput/page.mdx)
+- [CreateReservationItemInput](../../inventory_next/interfaces/inventory_next.CreateReservationItemInput/page.mdx)
+- [IInventoryServiceNext](../../inventory_next/interfaces/inventory_next.IInventoryServiceNext/page.mdx)
+- [JoinerServiceConfigAlias](../../inventory_next/interfaces/inventory_next.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../inventory_next/interfaces/inventory_next.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../inventory_next/interfaces/inventory_next.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../inventory_next/interfaces/inventory_next.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../inventory_next/interfaces/inventory_next.IMessageAggregator/page.mdx)
+- [Context](../../inventory_next/interfaces/inventory_next.Context/page.mdx)
+
+## Type Aliases
+
+- [Query](../../inventory_next/types/inventory_next.Query/page.mdx)
+- [ExpandScalar](../../inventory_next/types/inventory_next.ExpandScalar/page.mdx)
+- [Scalar](../../inventory_next/types/inventory_next.Scalar/page.mdx)
+- [ReadonlyPrimary](../../inventory_next/types/inventory_next.ReadonlyPrimary/page.mdx)
+- [Primary](../../inventory_next/types/inventory_next.Primary/page.mdx)
+- [OperatorMap](../../inventory_next/types/inventory_next.OperatorMap/page.mdx)
+- [FilterValue2](../../inventory_next/types/inventory_next.FilterValue2/page.mdx)
+- [FilterValue](../../inventory_next/types/inventory_next.FilterValue/page.mdx)
+- [PrevLimit](../../inventory_next/types/inventory_next.PrevLimit/page.mdx)
+- [FilterQuery](../../inventory_next/types/inventory_next.FilterQuery/page.mdx)
+- [MessageBody](../../inventory_next/types/inventory_next.MessageBody/page.mdx)
+- [Message](../../inventory_next/types/inventory_next.Message/page.mdx)
+- [MessageFormat](../../inventory_next/types/inventory_next.MessageFormat/page.mdx)
+- [JoinerRelationship](../../inventory_next/types/inventory_next.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../inventory_next/types/inventory_next.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../inventory_next/types/inventory_next.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,25 @@
+---
+displayed_sidebar: inventoryNextModelReference
+slug: /references/inventory-next/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Inventory Next Module Data Models Reference
+
+This documentation provides a reference to the data models in the Inventory Next Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	ReservationItem }|--|{ InventoryItem : inventory_item
+	InventoryItem ||--|| InventoryLevel : location_levels
+
+```
+
+## Classes
+
+- [InventoryItem](../../inventory_next_models/classes/inventory_next_models.InventoryItem/page.mdx)
+- [InventoryLevel](../../inventory_next_models/classes/inventory_next_models.InventoryLevel/page.mdx)
+- [ReservationItem](../../inventory_next_models/classes/inventory_next_models.ReservationItem/page.mdx)
@@ -0,0 +1,66 @@
+import { TypeList } from "docs-ui"
+
+# js-client
+
+## Classes
+
+- [AddressesResource](../../js_client/classes/js_client.AddressesResource/page.mdx)
+- [AdminAuthResource](../../js_client/classes/js_client.AdminAuthResource/page.mdx)
+- [AdminBatchJobsResource](../../js_client/classes/js_client.AdminBatchJobsResource/page.mdx)
+- [AdminCollectionsResource](../../js_client/classes/js_client.AdminCollectionsResource/page.mdx)
+- [AdminCurrenciesResource](../../js_client/classes/js_client.AdminCurrenciesResource/page.mdx)
+- [AdminCustomResource](../../js_client/classes/js_client.AdminCustomResource/page.mdx)
+- [AdminCustomerGroupsResource](../../js_client/classes/js_client.AdminCustomerGroupsResource/page.mdx)
+- [AdminCustomersResource](../../js_client/classes/js_client.AdminCustomersResource/page.mdx)
+- [AdminDiscountsResource](../../js_client/classes/js_client.AdminDiscountsResource/page.mdx)
+- [AdminDraftOrdersResource](../../js_client/classes/js_client.AdminDraftOrdersResource/page.mdx)
+- [AdminGiftCardsResource](../../js_client/classes/js_client.AdminGiftCardsResource/page.mdx)
+- [Admin](../../js_client/classes/js_client.Admin/page.mdx)
+- [AdminInventoryItemsResource](../../js_client/classes/js_client.AdminInventoryItemsResource/page.mdx)
+- [AdminInvitesResource](../../js_client/classes/js_client.AdminInvitesResource/page.mdx)
+- [AdminNotesResource](../../js_client/classes/js_client.AdminNotesResource/page.mdx)
+- [AdminNotificationsResource](../../js_client/classes/js_client.AdminNotificationsResource/page.mdx)
+- [AdminOrderEditsResource](../../js_client/classes/js_client.AdminOrderEditsResource/page.mdx)
+- [AdminOrdersResource](../../js_client/classes/js_client.AdminOrdersResource/page.mdx)
+- [AdminPaymentCollectionsResource](../../js_client/classes/js_client.AdminPaymentCollectionsResource/page.mdx)
+- [AdminPaymentsResource](../../js_client/classes/js_client.AdminPaymentsResource/page.mdx)
+- [AdminPriceListResource](../../js_client/classes/js_client.AdminPriceListResource/page.mdx)
+- [AdminProductCategoriesResource](../../js_client/classes/js_client.AdminProductCategoriesResource/page.mdx)
+- [AdminProductTagsResource](../../js_client/classes/js_client.AdminProductTagsResource/page.mdx)
+- [AdminProductTypesResource](../../js_client/classes/js_client.AdminProductTypesResource/page.mdx)
+- [AdminProductsResource](../../js_client/classes/js_client.AdminProductsResource/page.mdx)
+- [AdminPublishableApiKeyResource](../../js_client/classes/js_client.AdminPublishableApiKeyResource/page.mdx)
+- [AdminRegionsResource](../../js_client/classes/js_client.AdminRegionsResource/page.mdx)
+- [AdminReservationsResource](../../js_client/classes/js_client.AdminReservationsResource/page.mdx)
+- [AdminReturnReasonsResource](../../js_client/classes/js_client.AdminReturnReasonsResource/page.mdx)
+- [AdminReturnsResource](../../js_client/classes/js_client.AdminReturnsResource/page.mdx)
+- [AdminSalesChannelsResource](../../js_client/classes/js_client.AdminSalesChannelsResource/page.mdx)
+- [AdminShippingOptionsResource](../../js_client/classes/js_client.AdminShippingOptionsResource/page.mdx)
+- [AdminShippingProfilesResource](../../js_client/classes/js_client.AdminShippingProfilesResource/page.mdx)
+- [AdminStockLocationsResource](../../js_client/classes/js_client.AdminStockLocationsResource/page.mdx)
+- [AdminStoresResource](../../js_client/classes/js_client.AdminStoresResource/page.mdx)
+- [AdminSwapsResource](../../js_client/classes/js_client.AdminSwapsResource/page.mdx)
+- [AdminTaxRatesResource](../../js_client/classes/js_client.AdminTaxRatesResource/page.mdx)
+- [AdminUploadsResource](../../js_client/classes/js_client.AdminUploadsResource/page.mdx)
+- [AdminUsersResource](../../js_client/classes/js_client.AdminUsersResource/page.mdx)
+- [AdminVariantsResource](../../js_client/classes/js_client.AdminVariantsResource/page.mdx)
+- [AuthResource](../../js_client/classes/js_client.AuthResource/page.mdx)
+- [CartsResource](../../js_client/classes/js_client.CartsResource/page.mdx)
+- [CollectionsResource](../../js_client/classes/js_client.CollectionsResource/page.mdx)
+- [CustomersResource](../../js_client/classes/js_client.CustomersResource/page.mdx)
+- [GiftCardsResource](../../js_client/classes/js_client.GiftCardsResource/page.mdx)
+- [LineItemsResource](../../js_client/classes/js_client.LineItemsResource/page.mdx)
+- [OrderEditsResource](../../js_client/classes/js_client.OrderEditsResource/page.mdx)
+- [OrdersResource](../../js_client/classes/js_client.OrdersResource/page.mdx)
+- [PaymentCollectionsResource](../../js_client/classes/js_client.PaymentCollectionsResource/page.mdx)
+- [PaymentMethodsResource](../../js_client/classes/js_client.PaymentMethodsResource/page.mdx)
+- [ProductCategoriesResource](../../js_client/classes/js_client.ProductCategoriesResource/page.mdx)
+- [ProductTagsResource](../../js_client/classes/js_client.ProductTagsResource/page.mdx)
+- [ProductTypesResource](../../js_client/classes/js_client.ProductTypesResource/page.mdx)
+- [ProductVariantsResource](../../js_client/classes/js_client.ProductVariantsResource/page.mdx)
+- [ProductsResource](../../js_client/classes/js_client.ProductsResource/page.mdx)
+- [RegionsResource](../../js_client/classes/js_client.RegionsResource/page.mdx)
+- [ReturnReasonsResource](../../js_client/classes/js_client.ReturnReasonsResource/page.mdx)
+- [ReturnsResource](../../js_client/classes/js_client.ReturnsResource/page.mdx)
+- [ShippingOptionsResource](../../js_client/classes/js_client.ShippingOptionsResource/page.mdx)
+- [SwapsResource](../../js_client/classes/js_client.SwapsResource/page.mdx)
@@ -0,0 +1,13 @@
+import { TypeList } from "docs-ui"
+
+# medusa-config
+
+## Interfaces
+
+- [HttpCompressionOptions](../../medusa_config/interfaces/medusa_config.HttpCompressionOptions/page.mdx)
+- [ProjectConfigOptions](../../medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx)
+- [ConfigModule](../../medusa_config/interfaces/medusa_config.ConfigModule/page.mdx)
+
+## Type Aliases
+
+- [PluginDetails](../../medusa_config/types/medusa_config.PluginDetails/page.mdx)
@@ -0,0 +1,349 @@
+import { TypeList } from "docs-ui"
+
+# medusa-react
+
+## Namespaces
+
+- [Providers](../../medusa_react/medusa_react.Providers/page.mdx)
+- [Utilities](../../medusa_react/medusa_react.Utilities/page.mdx)
+- [Hooks](../../medusa_react/medusa_react.Hooks/page.mdx)
+
+## Interfaces
+
+- [CartContext](../../medusa_react/interfaces/medusa_react.CartContext/page.mdx)
+- [CartProps](../../medusa_react/interfaces/medusa_react.CartProps/page.mdx)
+- [MedusaContextState](../../medusa_react/interfaces/medusa_react.MedusaContextState/page.mdx)
+- [MedusaProviderProps](../../medusa_react/interfaces/medusa_react.MedusaProviderProps/page.mdx)
+- [Item](../../medusa_react/interfaces/medusa_react.Item/page.mdx)
+- [SessionCartState](../../medusa_react/interfaces/medusa_react.SessionCartState/page.mdx)
+- [SessionCartContextState](../../medusa_react/interfaces/medusa_react.SessionCartContextState/page.mdx)
+- [SessionCartProviderProps](../../medusa_react/interfaces/medusa_react.SessionCartProviderProps/page.mdx)
+- [FormatVariantPriceParams](../../medusa_react/interfaces/medusa_react.FormatVariantPriceParams/page.mdx)
+- [ComputeVariantPriceParams](../../medusa_react/interfaces/medusa_react.ComputeVariantPriceParams/page.mdx)
+
+## Type Aliases
+
+- [ComputeAmountParams](../../medusa_react/types/medusa_react.ComputeAmountParams/page.mdx)
+- [FormatAmountParams](../../medusa_react/types/medusa_react.FormatAmountParams/page.mdx)
+- [AdminUpdateClaimReq](../../medusa_react/types/medusa_react.AdminUpdateClaimReq/page.mdx)
+- [AdminFulfillClaimReq](../../medusa_react/types/medusa_react.AdminFulfillClaimReq/page.mdx)
+- [AdminCancelClaimFulfillmentReq](../../medusa_react/types/medusa_react.AdminCancelClaimFulfillmentReq/page.mdx)
+- [AdminDraftOrderUpdateLineItemReq](../../medusa_react/types/medusa_react.AdminDraftOrderUpdateLineItemReq/page.mdx)
+- [AdminUpdateLocationLevelReq](../../medusa_react/types/medusa_react.AdminUpdateLocationLevelReq/page.mdx)
+- [AdminUpdateVariantReq](../../medusa_react/types/medusa_react.AdminUpdateVariantReq/page.mdx)
+- [AdminUpdateProductOptionReq](../../medusa_react/types/medusa_react.AdminUpdateProductOptionReq/page.mdx)
+- [AdminFulfillSwapReq](../../medusa_react/types/medusa_react.AdminFulfillSwapReq/page.mdx)
+- [AdminCreateSwapShipmentReq](../../medusa_react/types/medusa_react.AdminCreateSwapShipmentReq/page.mdx)
+- [AdminCancelSwapFulfillmentReq](../../medusa_react/types/medusa_react.AdminCancelSwapFulfillmentReq/page.mdx)
+- [CreateCartReq](../../medusa_react/types/medusa_react.CreateCartReq/page.mdx)
+- [UpdatePaymentSessionReq](../../medusa_react/types/medusa_react.UpdatePaymentSessionReq/page.mdx)
+- [RefreshPaymentSessionMutationData](../../medusa_react/types/medusa_react.RefreshPaymentSessionMutationData/page.mdx)
+- [DeletePaymentSessionMutationData](../../medusa_react/types/medusa_react.DeletePaymentSessionMutationData/page.mdx)
+- [UpdateMeReq](../../medusa_react/types/medusa_react.UpdateMeReq/page.mdx)
+- [UpdateLineItemReq](../../medusa_react/types/medusa_react.UpdateLineItemReq/page.mdx)
+- [UseQueryOptionsWrapper](../../medusa_react/types/medusa_react.UseQueryOptionsWrapper/page.mdx)
+- [RegionInfo](../../medusa_react/types/medusa_react.RegionInfo/page.mdx)
+- [ProductVariant](../../medusa_react/types/medusa_react.ProductVariant/page.mdx)
+- [ProductVariantInfo](../../medusa_react/types/medusa_react.ProductVariantInfo/page.mdx)
+- [Cart](../../medusa_react/types/medusa_react.Cart/page.mdx)
+- [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)
+
+___
+
+## Variables
+
+### adminAuthKeys
+
+ `Const` **adminAuthKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_auth", any, string&#62;
+
+### adminBatchJobsKeys
+
+ `Const` **adminBatchJobsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_batches", any, string&#62;
+
+### adminCollectionKeys
+
+ `Const` **adminCollectionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_collections", any, string&#62;
+
+### adminCurrenciesKeys
+
+ `Const` **adminCurrenciesKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_currencies", any, string&#62;
+
+### adminCustomerKeys
+
+ `Const` **adminCustomerKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_customers", any, string&#62;
+
+### adminDiscountKeys
+
+ `Const` **adminDiscountKeys**: `Object`
+
+#### Properties
+
+<TypeList types={[{"name":"detailCondition","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_discounts\"`, `\"detail\"`, `string`, `\"condition\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_discounts\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_discounts\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_discounts\"`, `\"list\"`, ``{ query: any  }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_discounts\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_discounts\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="adminDiscountKeys"/>
+
+### adminDraftOrderKeys
+
+ `Const` **adminDraftOrderKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_draft_orders", any, string&#62;
+
+### adminGiftCardKeys
+
+ `Const` **adminGiftCardKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_gift_cards", any, string&#62;
+
+### adminInventoryItemsKeys
+
+ `Const` **adminInventoryItemsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_inventory_items", any, string&#62;
+
+### adminInviteKeys
+
+ `Const` **adminInviteKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_invites", any, string&#62;
+
+### adminNoteKeys
+
+ `Const` **adminNoteKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_notes", any, string&#62;
+
+### adminNotificationKeys
+
+ `Const` **adminNotificationKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_notifications", any, string&#62;
+
+### adminOrderEditsKeys
+
+ `Const` **adminOrderEditsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_order_edits", any, string&#62;
+
+### adminOrderKeys
+
+ `Const` **adminOrderKeys**: `Object`
+
+#### Properties
+
+<TypeList types={[{"name":"detailOrder","type":"(`id`: `string`, `query?`: [FindParams](../../medusa/classes/medusa.FindParams/page.mdx)) => (`string` \\| ``{ expand?: string ; fields?: string  }``)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_orders\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_orders\"`, `\"list\"`, ``{ query: any  }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_orders\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_orders\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="adminOrderKeys"/>
+
+### adminPaymentCollectionQueryKeys
+
+ `Const` **adminPaymentCollectionQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"paymentCollection", any, string&#62;
+
+### adminPaymentQueryKeys
+
+ `Const` **adminPaymentQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"payment", any, string&#62;
+
+### adminPriceListKeys
+
+ `Const` **adminPriceListKeys**: `Object`
+
+#### Properties
+
+<TypeList types={[{"name":"detailProducts","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_price_lists\"`, `\"detail\"`, `string`, `\"products\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_price_lists\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_price_lists\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_price_lists\"`, `\"list\"`, ``{ query: any  }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_price_lists\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_price_lists\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="adminPriceListKeys"/>
+
+### adminProductCategoryKeys
+
+ `Const` **adminProductCategoryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_categories", any, string&#62;
+
+### adminProductTagKeys
+
+ `Const` **adminProductTagKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_product_tags", any, string&#62;
+
+### adminProductTypeKeys
+
+ `Const` **adminProductTypeKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_product_types", any, string&#62;
+
+### adminProductKeys
+
+ `Const` **adminProductKeys**: `Object`
+
+#### Properties
+
+<TypeList types={[{"name":"detailVariants","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_products\"`, `\"detail\"`, `string`, `\"variants\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_products\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_products\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_products\"`, `\"list\"`, ``{ query: any  }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_products\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_products\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="adminProductKeys"/>
+
+### adminPublishableApiKeysKeys
+
+ `Const` **adminPublishableApiKeysKeys**: `Object`
+
+#### Properties
+
+<TypeList types={[{"name":"detailSalesChannels","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_publishable_api_keys\"`, `\"detail\"`, `string`, `\"sales_channels\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_publishable_api_keys\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_publishable_api_keys\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_publishable_api_keys\"`, `\"list\"`, ``{ query: any  }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_publishable_api_keys\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_publishable_api_keys\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="adminPublishableApiKeysKeys"/>
+
+### adminRegionKeys
+
+ `Const` **adminRegionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_regions", any, string&#62;
+
+### adminReservationsKeys
+
+ `Const` **adminReservationsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_reservations", any, string&#62;
+
+### adminReturnReasonKeys
+
+ `Const` **adminReturnReasonKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_return_reasons", any, string&#62;
+
+### adminReturnKeys
+
+ `Const` **adminReturnKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_returns", any, string&#62;
+
+### adminSalesChannelsKeys
+
+ `Const` **adminSalesChannelsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_sales_channels", any, string&#62;
+
+### adminShippingOptionKeys
+
+ `Const` **adminShippingOptionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_shipping_options", any, string&#62;
+
+### adminShippingProfileKeys
+
+ `Const` **adminShippingProfileKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_shippingProfiles", any, string&#62;
+
+### adminStockLocationsKeys
+
+ `Const` **adminStockLocationsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_stock_locations", any, string&#62;
+
+### adminStoreKeys
+
+ `Const` **adminStoreKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_store", any, string&#62;
+
+### adminSwapKeys
+
+ `Const` **adminSwapKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_swaps", any, string&#62;
+
+### adminTaxRateKeys
+
+ `Const` **adminTaxRateKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_tax_rates", any, string&#62;
+
+### adminUserKeys
+
+ `Const` **adminUserKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_users", any, string&#62;
+
+### adminVariantKeys
+
+ `Const` **adminVariantKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_variants", any, string&#62;
+
+### cartKeys
+
+ `Const` **cartKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"carts", any, string&#62;
+
+### collectionKeys
+
+ `Const` **collectionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"collections", any, string&#62;
+
+### customerKeys
+
+ `Const` **customerKeys**: `Object`
+
+#### Properties
+
+<TypeList types={[{"name":"orders","type":"(`id`: `string`) => readonly [`\"customers\"`, `\"detail\"`, `string`, `\"orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"customers\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"customers\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"customers\"`, `\"list\"`, ``{ query: any  }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"customers\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"customers\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="customerKeys"/>
+
+### giftCardKeys
+
+ `Const` **giftCardKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"gift_cards", any, string&#62;
+
+### orderEditQueryKeys
+
+ `Const` **orderEditQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"orderEdit", any, string&#62;
+
+### orderKeys
+
+ `Const` **orderKeys**: `Object`
+
+#### Properties
+
+<TypeList types={[{"name":"cart","type":"(`cartId`: `string`) => readonly [`\"orders\"`, `\"detail\"`, `\"cart\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"orders\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: [StoreGetOrdersParams](../../medusa/classes/medusa.StoreGetOrdersParams/page.mdx)) => [`\"orders\"`, `\"list\"`, ``{ query: undefined \\| [StoreGetOrdersParams](../../medusa/classes/medusa.StoreGetOrdersParams/page.mdx)  }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"orders\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"orders\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="orderKeys"/>
+
+### paymentCollectionQueryKeys
+
+ `Const` **paymentCollectionQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"paymentCollection", any, string&#62;
+
+### storeProductCategoryKeys
+
+ `Const` **storeProductCategoryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_categories", any, string&#62;
+
+### productTagKeys
+
+ `Const` **productTagKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_tags", any, string&#62;
+
+### productTypeKeys
+
+ `Const` **productTypeKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_types", any, string&#62;
+
+### productKeys
+
+ `Const` **productKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"products", StoreGetProductsParams, string&#62;
+
+___
+
+## Functions
+
+### useAdminConfirmBatchJob
+
+When a batch job is created, it's not executed automatically if `dry_run` is set to `true`. This hook confirms that the batch job should be executed.
+
+#### Example
+
+```ts
+import React from "react"
+import { useAdminConfirmBatchJob } from "medusa-react"
+
+type Props = {
+  batchJobId: string
+}
+
+const BatchJob = ({ batchJobId }: Props) => {
+  const confirmBatchJob = useAdminConfirmBatchJob(batchJobId)
+  // ...
+
+  const handleConfirm = () => {
+    confirmBatchJob.mutate(undefined, {
+      onSuccess: ({ batch_job }) => {
+        console.log(batch_job)
+      }
+    })
+  }
+
+  // ...
+}
+
+export default BatchJob
+```
+
+#### Hook Parameters
+
+<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="useAdminConfirmBatchJob"/>
+
+#### Mutation Function Returned Data
+
+<TypeList types={[{"name":"AdminBatchJobRes","type":"[AdminBatchJobRes](../../medusa/types/medusa.AdminBatchJobRes/page.mdx)","optional":false,"defaultValue":"","description":"The batch job's details.","expandable":false,"children":[{"name":"batch_job","type":"`BatchJob`","description":"Batch job details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}  sectionTitle="useAdminConfirmBatchJob"/>
+
+### useAdminCreateInvite
+
+#### Mutation Function Parameters
+
+<TypeList types={[{"name":"AdminPostInvitesPayload","type":"`AdminPostInvitesPayload`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="useAdminCreateInvite"/>
+
+### useAdminProductVariants
+
+#### Hook Parameters
+
+<TypeList types={[{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[AdminGetProductsVariantsParams](../../medusa/classes/medusa.AdminGetProductsVariantsParams/page.mdx)","description":"Configurations to apply on the retrieved product variants.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter product variants by.","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":"expand","type":"`string`","description":"Comma-separated relations that should be expanded 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":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"100","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product variants' title, sku, and products' title.","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":"inventory_quantity","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator/page.mdx)","description":"Number filters to apply on product variants' `inventory_quantity` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Filter product variants by whether their inventory is managed or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Filter product variants by whether they are allowed to be backordered or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator/page.mdx)","description":"Date filters to apply on the product variants' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator/page.mdx)","description":"Date filters to apply on the product variants' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}  sectionTitle="useAdminProductVariants"/>
+
+#### Query Returned Data
+
+<TypeList types={[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../medusa_react/types/medusa_react.ProductVariant/page.mdx)[]","description":"An array of product variants details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="useAdminProductVariants"/>
+
+### queryKeysFactory
+
+#### Type Parameters
+
+<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TListQueryType","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TDetailQueryType","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="queryKeysFactory"/>
+
+#### Parameters
+
+<TypeList types={[{"name":"globalKey","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="queryKeysFactory"/>
+
+#### Returns
+
+<TypeList types={[{"name":"TQueryKey","type":"[TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;T, TListQueryType, TDetailQueryType&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TListQueryType","type":"TListQueryType","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TDetailQueryType","type":"TDetailQueryType","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}  sectionTitle="queryKeysFactory"/>
+
+### useLocalStorage
+
+#### Parameters
+
+<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"initialState","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="useLocalStorage"/>
+
+#### Returns
+
+<TypeList types={[{"name":"readonly [string, (data: string) => void, () => void]","type":"readonly [`string`, (`data`: `string`) => `void`, () => `void`]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="useLocalStorage"/>
@@ -0,0 +1,12 @@
+import { TypeList } from "docs-ui"
+
+# notification
+
+## Classes
+
+- [AbstractNotificationService](../../notification/classes/notification.AbstractNotificationService/page.mdx)
+
+## Interfaces
+
+- [ReturnedData](../../notification/interfaces/notification.ReturnedData/page.mdx)
+- [INotificationService](../../notification/interfaces/notification.INotificationService/page.mdx)
@@ -0,0 +1,92 @@
+import { TypeList } from "docs-ui"
+
+# order
+
+## Interfaces
+
+- [FindConfig](../../order/interfaces/order.FindConfig/page.mdx)
+- [BaseFilterable](../../order/interfaces/order.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../order/interfaces/order.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../order/interfaces/order.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../order/interfaces/order.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../order/interfaces/order.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../order/interfaces/order.IModuleService/page.mdx)
+- [OrderAdjustmentLineDTO](../../order/interfaces/order.OrderAdjustmentLineDTO/page.mdx)
+- [OrderShippingMethodAdjustmentDTO](../../order/interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)
+- [OrderLineItemAdjustmentDTO](../../order/interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)
+- [OrderTaxLineDTO](../../order/interfaces/order.OrderTaxLineDTO/page.mdx)
+- [OrderShippingMethodTaxLineDTO](../../order/interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)
+- [OrderLineItemTaxLineDTO](../../order/interfaces/order.OrderLineItemTaxLineDTO/page.mdx)
+- [OrderAddressDTO](../../order/interfaces/order.OrderAddressDTO/page.mdx)
+- [OrderShippingMethodDTO](../../order/interfaces/order.OrderShippingMethodDTO/page.mdx)
+- [OrderLineItemTotalsDTO](../../order/interfaces/order.OrderLineItemTotalsDTO/page.mdx)
+- [OrderLineItemDTO](../../order/interfaces/order.OrderLineItemDTO/page.mdx)
+- [OrderItemDTO](../../order/interfaces/order.OrderItemDTO/page.mdx)
+- [OrderDTO](../../order/interfaces/order.OrderDTO/page.mdx)
+- [OrderChangeDTO](../../order/interfaces/order.OrderChangeDTO/page.mdx)
+- [OrderChangeActionDTO](../../order/interfaces/order.OrderChangeActionDTO/page.mdx)
+- [OrderTransactionDTO](../../order/interfaces/order.OrderTransactionDTO/page.mdx)
+- [FilterableOrderProps](../../order/interfaces/order.FilterableOrderProps/page.mdx)
+- [FilterableOrderAddressProps](../../order/interfaces/order.FilterableOrderAddressProps/page.mdx)
+- [FilterableOrderLineItemProps](../../order/interfaces/order.FilterableOrderLineItemProps/page.mdx)
+- [FilterableOrderLineItemAdjustmentProps](../../order/interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx)
+- [FilterableOrderShippingMethodProps](../../order/interfaces/order.FilterableOrderShippingMethodProps/page.mdx)
+- [FilterableOrderShippingMethodAdjustmentProps](../../order/interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx)
+- [FilterableOrderLineItemTaxLineProps](../../order/interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx)
+- [FilterableOrderShippingMethodTaxLineProps](../../order/interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx)
+- [UpsertOrderAddressDTO](../../order/interfaces/order.UpsertOrderAddressDTO/page.mdx)
+- [UpdateOrderAddressDTO](../../order/interfaces/order.UpdateOrderAddressDTO/page.mdx)
+- [CreateOrderAddressDTO](../../order/interfaces/order.CreateOrderAddressDTO/page.mdx)
+- [CreateOrderDTO](../../order/interfaces/order.CreateOrderDTO/page.mdx)
+- [UpdateOrderDTO](../../order/interfaces/order.UpdateOrderDTO/page.mdx)
+- [CreateOrderAdjustmentDTO](../../order/interfaces/order.CreateOrderAdjustmentDTO/page.mdx)
+- [UpdateOrderAdjustmentDTO](../../order/interfaces/order.UpdateOrderAdjustmentDTO/page.mdx)
+- [UpsertOrderLineItemAdjustmentDTO](../../order/interfaces/order.UpsertOrderLineItemAdjustmentDTO/page.mdx)
+- [CreateOrderTaxLineDTO](../../order/interfaces/order.CreateOrderTaxLineDTO/page.mdx)
+- [UpdateOrderTaxLineDTO](../../order/interfaces/order.UpdateOrderTaxLineDTO/page.mdx)
+- [CreateOrderShippingMethodTaxLineDTO](../../order/interfaces/order.CreateOrderShippingMethodTaxLineDTO/page.mdx)
+- [UpdateOrderShippingMethodTaxLineDTO](../../order/interfaces/order.UpdateOrderShippingMethodTaxLineDTO/page.mdx)
+- [CreateOrderLineItemTaxLineDTO](../../order/interfaces/order.CreateOrderLineItemTaxLineDTO/page.mdx)
+- [UpdateOrderLineItemTaxLineDTO](../../order/interfaces/order.UpdateOrderLineItemTaxLineDTO/page.mdx)
+- [CreateOrderLineItemDTO](../../order/interfaces/order.CreateOrderLineItemDTO/page.mdx)
+- [CreateOrderLineItemForOrderDTO](../../order/interfaces/order.CreateOrderLineItemForOrderDTO/page.mdx)
+- [UpdateOrderLineItemWithSelectorDTO](../../order/interfaces/order.UpdateOrderLineItemWithSelectorDTO/page.mdx)
+- [UpdateOrderLineItemDTO](../../order/interfaces/order.UpdateOrderLineItemDTO/page.mdx)
+- [CreateOrderShippingMethodDTO](../../order/interfaces/order.CreateOrderShippingMethodDTO/page.mdx)
+- [CreateOrderShippingMethodAdjustmentDTO](../../order/interfaces/order.CreateOrderShippingMethodAdjustmentDTO/page.mdx)
+- [UpdateOrderShippingMethodAdjustmentDTO](../../order/interfaces/order.UpdateOrderShippingMethodAdjustmentDTO/page.mdx)
+- [CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)
+- [CancelOrderChangeDTO](../../order/interfaces/order.CancelOrderChangeDTO/page.mdx)
+- [DeclineOrderChangeDTO](../../order/interfaces/order.DeclineOrderChangeDTO/page.mdx)
+- [ConfirmOrderChangeDTO](../../order/interfaces/order.ConfirmOrderChangeDTO/page.mdx)
+- [CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)
+- [CreateOrderTransactionDTO](../../order/interfaces/order.CreateOrderTransactionDTO/page.mdx)
+- [UpdateOrderItemDTO](../../order/interfaces/order.UpdateOrderItemDTO/page.mdx)
+- [UpdateOrderItemWithSelectorDTO](../../order/interfaces/order.UpdateOrderItemWithSelectorDTO/page.mdx)
+- [IOrderModuleService](../../order/interfaces/order.IOrderModuleService/page.mdx)
+- [MessageAggregatorFormat](../../order/interfaces/order.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../order/interfaces/order.IMessageAggregator/page.mdx)
+- [Context](../../order/interfaces/order.Context/page.mdx)
+
+## Type Aliases
+
+- [Query](../../order/types/order.Query/page.mdx)
+- [ExpandScalar](../../order/types/order.ExpandScalar/page.mdx)
+- [Scalar](../../order/types/order.Scalar/page.mdx)
+- [ReadonlyPrimary](../../order/types/order.ReadonlyPrimary/page.mdx)
+- [Primary](../../order/types/order.Primary/page.mdx)
+- [OperatorMap](../../order/types/order.OperatorMap/page.mdx)
+- [FilterValue2](../../order/types/order.FilterValue2/page.mdx)
+- [FilterValue](../../order/types/order.FilterValue/page.mdx)
+- [PrevLimit](../../order/types/order.PrevLimit/page.mdx)
+- [FilterQuery](../../order/types/order.FilterQuery/page.mdx)
+- [MessageBody](../../order/types/order.MessageBody/page.mdx)
+- [Message](../../order/types/order.Message/page.mdx)
+- [MessageFormat](../../order/types/order.MessageFormat/page.mdx)
+- [JoinerRelationship](../../order/types/order.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../order/types/order.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../order/types/order.ModuleJoinerRelationship/page.mdx)
+- [OrderSummaryDTO](../../order/types/order.OrderSummaryDTO/page.mdx)
+- [BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)
+- [BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)
+- [BigNumberValue](../../order/types/order.BigNumberValue/page.mdx)
@@ -0,0 +1,46 @@
+---
+displayed_sidebar: orderModelReference
+slug: /references/order/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Order Module Data Models Reference
+
+This documentation provides a reference to the data models in the Order Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	LineItem ||--|| LineItemTaxLine : tax_lines
+	LineItem ||--|| LineItemAdjustment : adjustments
+	Order }|--|{ Address : shipping_address
+	Order ||--|| OrderSummary : summary
+	Order ||--|| OrderItem : items
+	Order ||--|| ShippingMethod : shipping_methods
+	Order ||--|| Transaction : transactions
+	OrderChange }|--|{ Order : order
+	OrderChange ||--|| OrderChangeAction : actions
+	OrderChangeAction }|--|{ Order : order
+	OrderItem }|--|{ LineItem : item
+	ShippingMethod ||--|| ShippingMethodTaxLine : tax_lines
+	ShippingMethod ||--|| ShippingMethodAdjustment : adjustments
+
+```
+
+## Classes
+
+- [Address](../../order_models/classes/order_models.Address/page.mdx)
+- [LineItemAdjustment](../../order_models/classes/order_models.LineItemAdjustment/page.mdx)
+- [LineItemTaxLine](../../order_models/classes/order_models.LineItemTaxLine/page.mdx)
+- [LineItem](../../order_models/classes/order_models.LineItem/page.mdx)
+- [OrderChangeAction](../../order_models/classes/order_models.OrderChangeAction/page.mdx)
+- [OrderChange](../../order_models/classes/order_models.OrderChange/page.mdx)
+- [OrderItem](../../order_models/classes/order_models.OrderItem/page.mdx)
+- [OrderSummary](../../order_models/classes/order_models.OrderSummary/page.mdx)
+- [Order](../../order_models/classes/order_models.Order/page.mdx)
+- [ShippingMethodAdjustment](../../order_models/classes/order_models.ShippingMethodAdjustment/page.mdx)
+- [ShippingMethodTaxLine](../../order_models/classes/order_models.ShippingMethodTaxLine/page.mdx)
+- [ShippingMethod](../../order_models/classes/order_models.ShippingMethod/page.mdx)
+- [Transaction](../../order_models/classes/order_models.Transaction/page.mdx)
@@ -0,0 +1,68 @@
+import { TypeList } from "docs-ui"
+
+# payment
+
+## Enumerations
+
+- [PaymentCollectionStatus](../../payment/enums/payment.PaymentCollectionStatus/page.mdx)
+- [PaymentSessionStatus](../../payment/enums/payment.PaymentSessionStatus/page.mdx)
+
+## Interfaces
+
+- [FindConfig](../../payment/interfaces/payment.FindConfig/page.mdx)
+- [CustomerAddressDTO](../../payment/interfaces/payment.CustomerAddressDTO/page.mdx)
+- [CustomerDTO](../../payment/interfaces/payment.CustomerDTO/page.mdx)
+- [BaseFilterable](../../payment/interfaces/payment.BaseFilterable/page.mdx)
+- [JoinerServiceConfigAlias](../../payment/interfaces/payment.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../payment/interfaces/payment.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../payment/interfaces/payment.IModuleService/page.mdx)
+- [PaymentCollectionDTO](../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)
+- [FilterablePaymentCollectionProps](../../payment/interfaces/payment.FilterablePaymentCollectionProps/page.mdx)
+- [FilterablePaymentSessionProps](../../payment/interfaces/payment.FilterablePaymentSessionProps/page.mdx)
+- [FilterableCaptureProps](../../payment/interfaces/payment.FilterableCaptureProps/page.mdx)
+- [FilterableRefundProps](../../payment/interfaces/payment.FilterableRefundProps/page.mdx)
+- [PaymentDTO](../../payment/interfaces/payment.PaymentDTO/page.mdx)
+- [FilterablePaymentProps](../../payment/interfaces/payment.FilterablePaymentProps/page.mdx)
+- [CaptureDTO](../../payment/interfaces/payment.CaptureDTO/page.mdx)
+- [RefundDTO](../../payment/interfaces/payment.RefundDTO/page.mdx)
+- [PaymentSessionDTO](../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)
+- [PaymentProviderDTO](../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)
+- [FilterablePaymentProviderProps](../../payment/interfaces/payment.FilterablePaymentProviderProps/page.mdx)
+- [CreatePaymentCollectionDTO](../../payment/interfaces/payment.CreatePaymentCollectionDTO/page.mdx)
+- [UpsertPaymentCollectionDTO](../../payment/interfaces/payment.UpsertPaymentCollectionDTO/page.mdx)
+- [PaymentCollectionUpdatableFields](../../payment/interfaces/payment.PaymentCollectionUpdatableFields/page.mdx)
+- [UpdatePaymentDTO](../../payment/interfaces/payment.UpdatePaymentDTO/page.mdx)
+- [CreateCaptureDTO](../../payment/interfaces/payment.CreateCaptureDTO/page.mdx)
+- [CreateRefundDTO](../../payment/interfaces/payment.CreateRefundDTO/page.mdx)
+- [CreatePaymentSessionDTO](../../payment/interfaces/payment.CreatePaymentSessionDTO/page.mdx)
+- [UpdatePaymentSessionDTO](../../payment/interfaces/payment.UpdatePaymentSessionDTO/page.mdx)
+- [ProviderWebhookPayload](../../payment/interfaces/payment.ProviderWebhookPayload/page.mdx)
+- [PaymentProviderContext](../../payment/interfaces/payment.PaymentProviderContext/page.mdx)
+- [IPaymentModuleService](../../payment/interfaces/payment.IPaymentModuleService/page.mdx)
+- [PaymentModuleOptions](../../payment/interfaces/payment.PaymentModuleOptions/page.mdx)
+- [MessageAggregatorFormat](../../payment/interfaces/payment.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../payment/interfaces/payment.IMessageAggregator/page.mdx)
+- [Context](../../payment/interfaces/payment.Context/page.mdx)
+
+## Type Aliases
+
+- [AddressDTO](../../payment/types/payment.AddressDTO/page.mdx)
+- [Query](../../payment/types/payment.Query/page.mdx)
+- [ExpandScalar](../../payment/types/payment.ExpandScalar/page.mdx)
+- [Scalar](../../payment/types/payment.Scalar/page.mdx)
+- [ReadonlyPrimary](../../payment/types/payment.ReadonlyPrimary/page.mdx)
+- [Primary](../../payment/types/payment.Primary/page.mdx)
+- [OperatorMap](../../payment/types/payment.OperatorMap/page.mdx)
+- [FilterValue2](../../payment/types/payment.FilterValue2/page.mdx)
+- [FilterValue](../../payment/types/payment.FilterValue/page.mdx)
+- [PrevLimit](../../payment/types/payment.PrevLimit/page.mdx)
+- [FilterQuery](../../payment/types/payment.FilterQuery/page.mdx)
+- [MessageBody](../../payment/types/payment.MessageBody/page.mdx)
+- [Message](../../payment/types/payment.Message/page.mdx)
+- [MessageFormat](../../payment/types/payment.MessageFormat/page.mdx)
+- [JoinerRelationship](../../payment/types/payment.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../payment/types/payment.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../payment/types/payment.ModuleJoinerRelationship/page.mdx)
+- [BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)
+- [BigNumberInput](../../payment/types/payment.BigNumberInput/page.mdx)
+- [BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)
@@ -0,0 +1,33 @@
+---
+displayed_sidebar: paymentModelReference
+slug: /references/payment/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Payment Module Data Models Reference
+
+This documentation provides a reference to the data models in the Payment Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	Capture }|--|{ Payment : payment
+	Payment ||--|| Refund : refunds
+	Payment }|--|{ PaymentCollection : payment_collection
+	Payment ||--|| PaymentSession : payment_session
+	PaymentCollection }|--|{ PaymentProvider : payment_providers
+	PaymentCollection ||--|| PaymentSession : payment_sessions
+
+```
+
+## Classes
+
+- [Capture](../../payment_models/classes/payment_models.Capture/page.mdx)
+- [PaymentCollection](../../payment_models/classes/payment_models.PaymentCollection/page.mdx)
+- [PaymentMethodToken](../../payment_models/classes/payment_models.PaymentMethodToken/page.mdx)
+- [PaymentProvider](../../payment_models/classes/payment_models.PaymentProvider/page.mdx)
+- [PaymentSession](../../payment_models/classes/payment_models.PaymentSession/page.mdx)
+- [Payment](../../payment_models/classes/payment_models.Payment/page.mdx)
+- [Refund](../../payment_models/classes/payment_models.Refund/page.mdx)
@@ -0,0 +1,7 @@
+import { TypeList } from "docs-ui"
+
+# payment-provider
+
+## Classes
+
+- [AbstractPaymentProvider](../../payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx)
@@ -0,0 +1,77 @@
+import { TypeList } from "docs-ui"
+
+# pricing
+
+## Enumerations
+
+- [PriceListStatus](../../pricing/enums/pricing.PriceListStatus/page.mdx)
+- [PriceListType](../../pricing/enums/pricing.PriceListType/page.mdx)
+
+## Interfaces
+
+- [FindConfig](../../pricing/interfaces/pricing.FindConfig/page.mdx)
+- [BaseFilterable](../../pricing/interfaces/pricing.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../pricing/interfaces/pricing.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../pricing/interfaces/pricing.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../pricing/interfaces/pricing.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../pricing/interfaces/pricing.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../pricing/interfaces/pricing.IModuleService/page.mdx)
+- [MoneyAmountDTO](../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)
+- [CreateMoneyAmountDTO](../../pricing/interfaces/pricing.CreateMoneyAmountDTO/page.mdx)
+- [UpdateMoneyAmountDTO](../../pricing/interfaces/pricing.UpdateMoneyAmountDTO/page.mdx)
+- [FilterableMoneyAmountProps](../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)
+- [PriceListDTO](../../pricing/interfaces/pricing.PriceListDTO/page.mdx)
+- [CreatePriceListPriceDTO](../../pricing/interfaces/pricing.CreatePriceListPriceDTO/page.mdx)
+- [UpdatePriceListPriceDTO](../../pricing/interfaces/pricing.UpdatePriceListPriceDTO/page.mdx)
+- [CreatePriceSetPriceRules](../../pricing/interfaces/pricing.CreatePriceSetPriceRules/page.mdx)
+- [CreatePriceListRules](../../pricing/interfaces/pricing.CreatePriceListRules/page.mdx)
+- [CreatePriceListDTO](../../pricing/interfaces/pricing.CreatePriceListDTO/page.mdx)
+- [UpdatePriceListDTO](../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx)
+- [FilterablePriceListProps](../../pricing/interfaces/pricing.FilterablePriceListProps/page.mdx)
+- [FilterablePriceListRuleProps](../../pricing/interfaces/pricing.FilterablePriceListRuleProps/page.mdx)
+- [PriceListRuleDTO](../../pricing/interfaces/pricing.PriceListRuleDTO/page.mdx)
+- [CreatePriceListRuleDTO](../../pricing/interfaces/pricing.CreatePriceListRuleDTO/page.mdx)
+- [UpdatePriceListRuleDTO](../../pricing/interfaces/pricing.UpdatePriceListRuleDTO/page.mdx)
+- [PriceListRuleValueDTO](../../pricing/interfaces/pricing.PriceListRuleValueDTO/page.mdx)
+- [AddPriceListPricesDTO](../../pricing/interfaces/pricing.AddPriceListPricesDTO/page.mdx)
+- [UpdatePriceListPricesDTO](../../pricing/interfaces/pricing.UpdatePriceListPricesDTO/page.mdx)
+- [SetPriceListRulesDTO](../../pricing/interfaces/pricing.SetPriceListRulesDTO/page.mdx)
+- [RemovePriceListRulesDTO](../../pricing/interfaces/pricing.RemovePriceListRulesDTO/page.mdx)
+- [PriceRuleDTO](../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)
+- [CreatePriceRuleDTO](../../pricing/interfaces/pricing.CreatePriceRuleDTO/page.mdx)
+- [UpdatePriceRuleDTO](../../pricing/interfaces/pricing.UpdatePriceRuleDTO/page.mdx)
+- [FilterablePriceRuleProps](../../pricing/interfaces/pricing.FilterablePriceRuleProps/page.mdx)
+- [PricingContext](../../pricing/interfaces/pricing.PricingContext/page.mdx)
+- [PricingFilters](../../pricing/interfaces/pricing.PricingFilters/page.mdx)
+- [PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)
+- [CalculatedPriceSet](../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)
+- [AddRulesDTO](../../pricing/interfaces/pricing.AddRulesDTO/page.mdx)
+- [CreatePricesDTO](../../pricing/interfaces/pricing.CreatePricesDTO/page.mdx)
+- [AddPricesDTO](../../pricing/interfaces/pricing.AddPricesDTO/page.mdx)
+- [RemovePriceSetRulesDTO](../../pricing/interfaces/pricing.RemovePriceSetRulesDTO/page.mdx)
+- [CreatePriceSetDTO](../../pricing/interfaces/pricing.CreatePriceSetDTO/page.mdx)
+- [UpsertPriceSetDTO](../../pricing/interfaces/pricing.UpsertPriceSetDTO/page.mdx)
+- [UpdatePriceSetDTO](../../pricing/interfaces/pricing.UpdatePriceSetDTO/page.mdx)
+- [FilterablePriceSetProps](../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)
+- [PriceDTO](../../pricing/interfaces/pricing.PriceDTO/page.mdx)
+- [FilterablePriceProps](../../pricing/interfaces/pricing.FilterablePriceProps/page.mdx)
+- [RuleTypeDTO](../../pricing/interfaces/pricing.RuleTypeDTO/page.mdx)
+- [CreateRuleTypeDTO](../../pricing/interfaces/pricing.CreateRuleTypeDTO/page.mdx)
+- [UpdateRuleTypeDTO](../../pricing/interfaces/pricing.UpdateRuleTypeDTO/page.mdx)
+- [FilterableRuleTypeProps](../../pricing/interfaces/pricing.FilterableRuleTypeProps/page.mdx)
+- [IPricingModuleService](../../pricing/interfaces/pricing.IPricingModuleService/page.mdx)
+- [MessageAggregatorFormat](../../pricing/interfaces/pricing.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../pricing/interfaces/pricing.IMessageAggregator/page.mdx)
+- [Context](../../pricing/interfaces/pricing.Context/page.mdx)
+
+## Type Aliases
+
+- [MessageBody](../../pricing/types/pricing.MessageBody/page.mdx)
+- [Message](../../pricing/types/pricing.Message/page.mdx)
+- [MessageFormat](../../pricing/types/pricing.MessageFormat/page.mdx)
+- [JoinerRelationship](../../pricing/types/pricing.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../pricing/types/pricing.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../pricing/types/pricing.ModuleJoinerRelationship/page.mdx)
+- [BigNumberRawValue](../../pricing/types/pricing.BigNumberRawValue/page.mdx)
+- [BigNumberInput](../../pricing/types/pricing.BigNumberInput/page.mdx)
+- [BigNumberValue](../../pricing/types/pricing.BigNumberValue/page.mdx)
@@ -0,0 +1,38 @@
+---
+displayed_sidebar: pricingModelReference
+slug: /references/pricing/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Pricing Module Data Models Reference
+
+This documentation provides a reference to the data models in the Pricing Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	Price }|--|{ PriceSet : price_set
+	Price ||--|| PriceRule : price_rules
+	Price }|--|{ PriceList : price_list
+	PriceList ||--|| PriceListRule : price_list_rules
+	PriceList }|--|{ RuleType : rule_types
+	PriceListRule }|--|{ RuleType : rule_type
+	PriceListRule ||--|| PriceListRuleValue : price_list_rule_values
+	PriceRule }|--|{ PriceSet : price_set
+	PriceRule }|--|{ RuleType : rule_type
+	PriceSet }|--|{ RuleType : rule_types
+
+```
+
+## Classes
+
+- [PriceListRuleValue](../../pricing_models/classes/pricing_models.PriceListRuleValue/page.mdx)
+- [PriceListRule](../../pricing_models/classes/pricing_models.PriceListRule/page.mdx)
+- [PriceList](../../pricing_models/classes/pricing_models.PriceList/page.mdx)
+- [PriceRule](../../pricing_models/classes/pricing_models.PriceRule/page.mdx)
+- [PriceSetRuleType](../../pricing_models/classes/pricing_models.PriceSetRuleType/page.mdx)
+- [PriceSet](../../pricing_models/classes/pricing_models.PriceSet/page.mdx)
+- [Price](../../pricing_models/classes/pricing_models.Price/page.mdx)
+- [RuleType](../../pricing_models/classes/pricing_models.RuleType/page.mdx)
@@ -0,0 +1,78 @@
+import { TypeList } from "docs-ui"
+
+# product
+
+## Enumerations
+
+- [ProductStatus](../../product/enums/product.ProductStatus/page.mdx)
+
+## Interfaces
+
+- [FindConfig](../../product/interfaces/product.FindConfig/page.mdx)
+- [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../product/interfaces/product.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../product/interfaces/product.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../product/interfaces/product.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../product/interfaces/product.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../product/interfaces/product.IModuleService/page.mdx)
+- [ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)
+- [ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO/page.mdx)
+- [ProductCategoryDTO](../../product/interfaces/product.ProductCategoryDTO/page.mdx)
+- [CreateProductCategoryDTO](../../product/interfaces/product.CreateProductCategoryDTO/page.mdx)
+- [UpdateProductCategoryDTO](../../product/interfaces/product.UpdateProductCategoryDTO/page.mdx)
+- [ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)
+- [ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)
+- [ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)
+- [ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)
+- [ProductImageDTO](../../product/interfaces/product.ProductImageDTO/page.mdx)
+- [ProductOptionValueDTO](../../product/interfaces/product.ProductOptionValueDTO/page.mdx)
+- [FilterableProductProps](../../product/interfaces/product.FilterableProductProps/page.mdx)
+- [FilterableProductTagProps](../../product/interfaces/product.FilterableProductTagProps/page.mdx)
+- [FilterableProductTypeProps](../../product/interfaces/product.FilterableProductTypeProps/page.mdx)
+- [FilterableProductOptionProps](../../product/interfaces/product.FilterableProductOptionProps/page.mdx)
+- [FilterableProductCollectionProps](../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)
+- [FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)
+- [FilterableProductCategoryProps](../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)
+- [CreateProductCollectionDTO](../../product/interfaces/product.CreateProductCollectionDTO/page.mdx)
+- [UpsertProductCollectionDTO](../../product/interfaces/product.UpsertProductCollectionDTO/page.mdx)
+- [UpdateProductCollectionDTO](../../product/interfaces/product.UpdateProductCollectionDTO/page.mdx)
+- [CreateProductTypeDTO](../../product/interfaces/product.CreateProductTypeDTO/page.mdx)
+- [UpsertProductTypeDTO](../../product/interfaces/product.UpsertProductTypeDTO/page.mdx)
+- [UpdateProductTypeDTO](../../product/interfaces/product.UpdateProductTypeDTO/page.mdx)
+- [UpsertProductImageDTO](../../product/interfaces/product.UpsertProductImageDTO/page.mdx)
+- [UpdateProductImageDTO](../../product/interfaces/product.UpdateProductImageDTO/page.mdx)
+- [CreateProductTagDTO](../../product/interfaces/product.CreateProductTagDTO/page.mdx)
+- [UpsertProductTagDTO](../../product/interfaces/product.UpsertProductTagDTO/page.mdx)
+- [UpdateProductTagDTO](../../product/interfaces/product.UpdateProductTagDTO/page.mdx)
+- [CreateProductOptionDTO](../../product/interfaces/product.CreateProductOptionDTO/page.mdx)
+- [UpsertProductOptionDTO](../../product/interfaces/product.UpsertProductOptionDTO/page.mdx)
+- [UpdateProductOptionDTO](../../product/interfaces/product.UpdateProductOptionDTO/page.mdx)
+- [CreateProductVariantDTO](../../product/interfaces/product.CreateProductVariantDTO/page.mdx)
+- [UpsertProductVariantDTO](../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)
+- [UpdateProductVariantDTO](../../product/interfaces/product.UpdateProductVariantDTO/page.mdx)
+- [CreateProductDTO](../../product/interfaces/product.CreateProductDTO/page.mdx)
+- [UpsertProductDTO](../../product/interfaces/product.UpsertProductDTO/page.mdx)
+- [UpdateProductDTO](../../product/interfaces/product.UpdateProductDTO/page.mdx)
+- [IProductModuleService](../../product/interfaces/product.IProductModuleService/page.mdx)
+- [MessageAggregatorFormat](../../product/interfaces/product.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../product/interfaces/product.IMessageAggregator/page.mdx)
+- [Context](../../product/interfaces/product.Context/page.mdx)
+
+## Type Aliases
+
+- [Query](../../product/types/product.Query/page.mdx)
+- [ExpandScalar](../../product/types/product.ExpandScalar/page.mdx)
+- [Scalar](../../product/types/product.Scalar/page.mdx)
+- [ReadonlyPrimary](../../product/types/product.ReadonlyPrimary/page.mdx)
+- [Primary](../../product/types/product.Primary/page.mdx)
+- [OperatorMap](../../product/types/product.OperatorMap/page.mdx)
+- [FilterValue2](../../product/types/product.FilterValue2/page.mdx)
+- [FilterValue](../../product/types/product.FilterValue/page.mdx)
+- [PrevLimit](../../product/types/product.PrevLimit/page.mdx)
+- [FilterQuery](../../product/types/product.FilterQuery/page.mdx)
+- [MessageBody](../../product/types/product.MessageBody/page.mdx)
+- [Message](../../product/types/product.Message/page.mdx)
+- [MessageFormat](../../product/types/product.MessageFormat/page.mdx)
+- [JoinerRelationship](../../product/types/product.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../product/types/product.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../product/types/product.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,39 @@
+---
+displayed_sidebar: productModelReference
+slug: /references/product/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Product Module Data Models Reference
+
+This documentation provides a reference to the data models in the Product Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	Product ||--|| ProductOption : options
+	Product ||--|| ProductVariant : variants
+	Product }|--|{ ProductCollection : collection
+	Product }|--|{ ProductType : type
+	Product }|--|{ ProductTag : tags
+	Product }|--|{ Image : images
+	Product }|--|{ ProductCategory : categories
+	ProductCategory }|--|{ ProductCategory : parent_category
+	ProductVariant }|--|{ ProductOptionValue : options
+	ProductOption ||--|| ProductOptionValue : values
+
+```
+
+## Classes
+
+- [ProductCategory](../../product_models/classes/product_models.ProductCategory/page.mdx)
+- [ProductCollection](../../product_models/classes/product_models.ProductCollection/page.mdx)
+- [Image](../../product_models/classes/product_models.Image/page.mdx)
+- [ProductOptionValue](../../product_models/classes/product_models.ProductOptionValue/page.mdx)
+- [ProductOption](../../product_models/classes/product_models.ProductOption/page.mdx)
+- [ProductTag](../../product_models/classes/product_models.ProductTag/page.mdx)
+- [ProductType](../../product_models/classes/product_models.ProductType/page.mdx)
+- [ProductVariant](../../product_models/classes/product_models.ProductVariant/page.mdx)
+- [Product](../../product_models/classes/product_models.Product/page.mdx)
@@ -0,0 +1,71 @@
+import { TypeList } from "docs-ui"
+
+# promotion
+
+## Interfaces
+
+- [FindConfig](../../promotion/interfaces/promotion.FindConfig/page.mdx)
+- [BaseFilterable](../../promotion/interfaces/promotion.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../promotion/interfaces/promotion.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../promotion/interfaces/promotion.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../promotion/interfaces/promotion.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../promotion/interfaces/promotion.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../promotion/interfaces/promotion.IModuleService/page.mdx)
+- [ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)
+- [CreateApplicationMethodDTO](../../promotion/interfaces/promotion.CreateApplicationMethodDTO/page.mdx)
+- [UpdateApplicationMethodDTO](../../promotion/interfaces/promotion.UpdateApplicationMethodDTO/page.mdx)
+- [CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)
+- [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)
+- [FilterableCampaignProps](../../promotion/interfaces/promotion.FilterableCampaignProps/page.mdx)
+- [CampaignBudgetExceededAction](../../promotion/interfaces/promotion.CampaignBudgetExceededAction/page.mdx)
+- [AddItemAdjustmentAction](../../promotion/interfaces/promotion.AddItemAdjustmentAction/page.mdx)
+- [RemoveItemAdjustmentAction](../../promotion/interfaces/promotion.RemoveItemAdjustmentAction/page.mdx)
+- [AddShippingMethodAdjustment](../../promotion/interfaces/promotion.AddShippingMethodAdjustment/page.mdx)
+- [RemoveShippingMethodAdjustment](../../promotion/interfaces/promotion.RemoveShippingMethodAdjustment/page.mdx)
+- [ComputeActionAdjustmentLine](../../promotion/interfaces/promotion.ComputeActionAdjustmentLine/page.mdx)
+- [ComputeActionItemLine](../../promotion/interfaces/promotion.ComputeActionItemLine/page.mdx)
+- [ComputeActionShippingLine](../../promotion/interfaces/promotion.ComputeActionShippingLine/page.mdx)
+- [ComputeActionContext](../../promotion/interfaces/promotion.ComputeActionContext/page.mdx)
+- [PromotionRuleValueDTO](../../promotion/interfaces/promotion.PromotionRuleValueDTO/page.mdx)
+- [PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)
+- [CreatePromotionRuleDTO](../../promotion/interfaces/promotion.CreatePromotionRuleDTO/page.mdx)
+- [UpdatePromotionRuleDTO](../../promotion/interfaces/promotion.UpdatePromotionRuleDTO/page.mdx)
+- [FilterablePromotionRuleProps](../../promotion/interfaces/promotion.FilterablePromotionRuleProps/page.mdx)
+- [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)
+- [CreatePromotionDTO](../../promotion/interfaces/promotion.CreatePromotionDTO/page.mdx)
+- [UpdatePromotionDTO](../../promotion/interfaces/promotion.UpdatePromotionDTO/page.mdx)
+- [FilterablePromotionProps](../../promotion/interfaces/promotion.FilterablePromotionProps/page.mdx)
+- [CreateCampaignBudgetDTO](../../promotion/interfaces/promotion.CreateCampaignBudgetDTO/page.mdx)
+- [UpdateCampaignBudgetDTO](../../promotion/interfaces/promotion.UpdateCampaignBudgetDTO/page.mdx)
+- [CreateCampaignDTO](../../promotion/interfaces/promotion.CreateCampaignDTO/page.mdx)
+- [UpdateCampaignDTO](../../promotion/interfaces/promotion.UpdateCampaignDTO/page.mdx)
+- [IPromotionModuleService](../../promotion/interfaces/promotion.IPromotionModuleService/page.mdx)
+- [MessageAggregatorFormat](../../promotion/interfaces/promotion.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../promotion/interfaces/promotion.IMessageAggregator/page.mdx)
+- [Context](../../promotion/interfaces/promotion.Context/page.mdx)
+
+## Type Aliases
+
+- [Query](../../promotion/types/promotion.Query/page.mdx)
+- [ExpandScalar](../../promotion/types/promotion.ExpandScalar/page.mdx)
+- [Scalar](../../promotion/types/promotion.Scalar/page.mdx)
+- [ReadonlyPrimary](../../promotion/types/promotion.ReadonlyPrimary/page.mdx)
+- [Primary](../../promotion/types/promotion.Primary/page.mdx)
+- [OperatorMap](../../promotion/types/promotion.OperatorMap/page.mdx)
+- [FilterValue2](../../promotion/types/promotion.FilterValue2/page.mdx)
+- [FilterValue](../../promotion/types/promotion.FilterValue/page.mdx)
+- [PrevLimit](../../promotion/types/promotion.PrevLimit/page.mdx)
+- [FilterQuery](../../promotion/types/promotion.FilterQuery/page.mdx)
+- [MessageBody](../../promotion/types/promotion.MessageBody/page.mdx)
+- [Message](../../promotion/types/promotion.Message/page.mdx)
+- [MessageFormat](../../promotion/types/promotion.MessageFormat/page.mdx)
+- [JoinerRelationship](../../promotion/types/promotion.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../promotion/types/promotion.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../promotion/types/promotion.ModuleJoinerRelationship/page.mdx)
+- [ApplicationMethodTypeValues](../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)
+- [ApplicationMethodTargetTypeValues](../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)
+- [ApplicationMethodAllocationValues](../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)
+- [CampaignBudgetTypeValues](../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)
+- [ComputeActions](../../promotion/types/promotion.ComputeActions/page.mdx)
+- [PromotionRuleOperatorValues](../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)
+- [PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)
@@ -0,0 +1,32 @@
+---
+displayed_sidebar: promotionModelReference
+slug: /references/promotion/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Promotion Module Data Models Reference
+
+This documentation provides a reference to the data models in the Promotion Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	ApplicationMethod ||--|| Promotion : promotion
+	ApplicationMethod }|--|{ PromotionRule : target_rules
+	Campaign ||--|| CampaignBudget : budget
+	Campaign ||--|| Promotion : promotions
+	Promotion }|--|{ PromotionRule : rules
+	PromotionRule ||--|| PromotionRuleValue : values
+
+```
+
+## Classes
+
+- [ApplicationMethod](../../promotion_models/classes/promotion_models.ApplicationMethod/page.mdx)
+- [CampaignBudget](../../promotion_models/classes/promotion_models.CampaignBudget/page.mdx)
+- [Campaign](../../promotion_models/classes/promotion_models.Campaign/page.mdx)
+- [PromotionRuleValue](../../promotion_models/classes/promotion_models.PromotionRuleValue/page.mdx)
+- [PromotionRule](../../promotion_models/classes/promotion_models.PromotionRule/page.mdx)
+- [Promotion](../../promotion_models/classes/promotion_models.Promotion/page.mdx)
@@ -0,0 +1,44 @@
+import { TypeList } from "docs-ui"
+
+# region
+
+## Interfaces
+
+- [FindConfig](../../region/interfaces/region.FindConfig/page.mdx)
+- [BaseFilterable](../../region/interfaces/region.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../region/interfaces/region.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../region/interfaces/region.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../region/interfaces/region.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../region/interfaces/region.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../region/interfaces/region.IModuleService/page.mdx)
+- [PaymentProviderDTO](../../region/interfaces/region.PaymentProviderDTO/page.mdx)
+- [RegionDTO](../../region/interfaces/region.RegionDTO/page.mdx)
+- [RegionCountryDTO](../../region/interfaces/region.RegionCountryDTO/page.mdx)
+- [FilterableRegionProps](../../region/interfaces/region.FilterableRegionProps/page.mdx)
+- [FilterableRegionCountryProps](../../region/interfaces/region.FilterableRegionCountryProps/page.mdx)
+- [CreateRegionDTO](../../region/interfaces/region.CreateRegionDTO/page.mdx)
+- [UpsertRegionDTO](../../region/interfaces/region.UpsertRegionDTO/page.mdx)
+- [UpdateRegionDTO](../../region/interfaces/region.UpdateRegionDTO/page.mdx)
+- [IRegionModuleService](../../region/interfaces/region.IRegionModuleService/page.mdx)
+- [MessageAggregatorFormat](../../region/interfaces/region.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../region/interfaces/region.IMessageAggregator/page.mdx)
+- [Context](../../region/interfaces/region.Context/page.mdx)
+
+## Type Aliases
+
+- [Query](../../region/types/region.Query/page.mdx)
+- [ExpandScalar](../../region/types/region.ExpandScalar/page.mdx)
+- [Scalar](../../region/types/region.Scalar/page.mdx)
+- [ReadonlyPrimary](../../region/types/region.ReadonlyPrimary/page.mdx)
+- [Primary](../../region/types/region.Primary/page.mdx)
+- [OperatorMap](../../region/types/region.OperatorMap/page.mdx)
+- [FilterValue2](../../region/types/region.FilterValue2/page.mdx)
+- [FilterValue](../../region/types/region.FilterValue/page.mdx)
+- [PrevLimit](../../region/types/region.PrevLimit/page.mdx)
+- [FilterQuery](../../region/types/region.FilterQuery/page.mdx)
+- [MessageBody](../../region/types/region.MessageBody/page.mdx)
+- [Message](../../region/types/region.Message/page.mdx)
+- [MessageFormat](../../region/types/region.MessageFormat/page.mdx)
+- [JoinerRelationship](../../region/types/region.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../region/types/region.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../region/types/region.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,23 @@
+---
+displayed_sidebar: regionModelReference
+slug: /references/region/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Region Module Data Models Reference
+
+This documentation provides a reference to the data models in the Region Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	Country }|--|{ Region : region
+
+```
+
+## Classes
+
+- [Country](../../region_models/classes/region_models.Country/page.mdx)
+- [Region](../../region_models/classes/region_models.Region/page.mdx)
@@ -0,0 +1,32 @@
+import { TypeList } from "docs-ui"
+
+# sales-channel
+
+## Interfaces
+
+- [FindConfig](../../sales_channel/interfaces/sales_channel.FindConfig/page.mdx)
+- [BaseFilterable](../../sales_channel/interfaces/sales_channel.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../sales_channel/interfaces/sales_channel.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../sales_channel/interfaces/sales_channel.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../sales_channel/interfaces/sales_channel.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../sales_channel/interfaces/sales_channel.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../sales_channel/interfaces/sales_channel.IModuleService/page.mdx)
+- [SalesChannelLocationDTO](../../sales_channel/interfaces/sales_channel.SalesChannelLocationDTO/page.mdx)
+- [SalesChannelDTO](../../sales_channel/interfaces/sales_channel.SalesChannelDTO/page.mdx)
+- [FilterableSalesChannelProps](../../sales_channel/interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)
+- [CreateSalesChannelDTO](../../sales_channel/interfaces/sales_channel.CreateSalesChannelDTO/page.mdx)
+- [UpdateSalesChannelDTO](../../sales_channel/interfaces/sales_channel.UpdateSalesChannelDTO/page.mdx)
+- [UpsertSalesChannelDTO](../../sales_channel/interfaces/sales_channel.UpsertSalesChannelDTO/page.mdx)
+- [ISalesChannelModuleService](../../sales_channel/interfaces/sales_channel.ISalesChannelModuleService/page.mdx)
+- [MessageAggregatorFormat](../../sales_channel/interfaces/sales_channel.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../sales_channel/interfaces/sales_channel.IMessageAggregator/page.mdx)
+- [Context](../../sales_channel/interfaces/sales_channel.Context/page.mdx)
+
+## Type Aliases
+
+- [MessageBody](../../sales_channel/types/sales_channel.MessageBody/page.mdx)
+- [Message](../../sales_channel/types/sales_channel.Message/page.mdx)
+- [MessageFormat](../../sales_channel/types/sales_channel.MessageFormat/page.mdx)
+- [JoinerRelationship](../../sales_channel/types/sales_channel.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../sales_channel/types/sales_channel.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../sales_channel/types/sales_channel.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,14 @@
+---
+displayed_sidebar: salesChannelModelReference
+slug: /references/sales-channel/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Sales Channel Module Data Models Reference
+
+This documentation provides a reference to the data models in the Sales Channel Module
+
+## Classes
+
+- [SalesChannel](../../sales_channel_models/classes/sales_channel_models.SalesChannel/page.mdx)
@@ -0,0 +1,7 @@
+import { TypeList } from "docs-ui"
+
+# search
+
+## Classes
+
+- [AbstractSearchService](../../search/classes/search.AbstractSearchService/page.mdx)
@@ -0,0 +1,57 @@
+import { TypeList } from "docs-ui"
+
+# stock-location-next
+
+## Interfaces
+
+- [FindConfig](../../stock_location_next/interfaces/stock_location_next.FindConfig/page.mdx)
+- [BaseFilterable](../../stock_location_next/interfaces/stock_location_next.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../stock_location_next/interfaces/stock_location_next.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../stock_location_next/interfaces/stock_location_next.RestoreReturn/page.mdx)
+- [FulfillmentAddressDTO](../../stock_location_next/interfaces/stock_location_next.FulfillmentAddressDTO/page.mdx)
+- [FulfillmentItemDTO](../../stock_location_next/interfaces/stock_location_next.FulfillmentItemDTO/page.mdx)
+- [FulfillmentLabelDTO](../../stock_location_next/interfaces/stock_location_next.FulfillmentLabelDTO/page.mdx)
+- [FulfillmentProviderDTO](../../stock_location_next/interfaces/stock_location_next.FulfillmentProviderDTO/page.mdx)
+- [FulfillmentSetDTO](../../stock_location_next/interfaces/stock_location_next.FulfillmentSetDTO/page.mdx)
+- [FulfillmentDTO](../../stock_location_next/interfaces/stock_location_next.FulfillmentDTO/page.mdx)
+- [GeoZoneDTO](../../stock_location_next/interfaces/stock_location_next.GeoZoneDTO/page.mdx)
+- [ServiceZoneDTO](../../stock_location_next/interfaces/stock_location_next.ServiceZoneDTO/page.mdx)
+- [ShippingOptionRuleDTO](../../stock_location_next/interfaces/stock_location_next.ShippingOptionRuleDTO/page.mdx)
+- [ShippingOptionTypeDTO](../../stock_location_next/interfaces/stock_location_next.ShippingOptionTypeDTO/page.mdx)
+- [ShippingOptionDTO](../../stock_location_next/interfaces/stock_location_next.ShippingOptionDTO/page.mdx)
+- [ShippingProfileDTO](../../stock_location_next/interfaces/stock_location_next.ShippingProfileDTO/page.mdx)
+- [JoinerServiceConfigAlias](../../stock_location_next/interfaces/stock_location_next.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../stock_location_next/interfaces/stock_location_next.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../stock_location_next/interfaces/stock_location_next.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../stock_location_next/interfaces/stock_location_next.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../stock_location_next/interfaces/stock_location_next.IMessageAggregator/page.mdx)
+- [Context](../../stock_location_next/interfaces/stock_location_next.Context/page.mdx)
+- [FilterableStockLocationProps](../../stock_location_next/interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)
+- [UpdateStockLocationNextInput](../../stock_location_next/interfaces/stock_location_next.UpdateStockLocationNextInput/page.mdx)
+- [IStockLocationServiceNext](../../stock_location_next/interfaces/stock_location_next.IStockLocationServiceNext/page.mdx)
+
+## Type Aliases
+
+- [Query](../../stock_location_next/types/stock_location_next.Query/page.mdx)
+- [ExpandScalar](../../stock_location_next/types/stock_location_next.ExpandScalar/page.mdx)
+- [Scalar](../../stock_location_next/types/stock_location_next.Scalar/page.mdx)
+- [ReadonlyPrimary](../../stock_location_next/types/stock_location_next.ReadonlyPrimary/page.mdx)
+- [Primary](../../stock_location_next/types/stock_location_next.Primary/page.mdx)
+- [OperatorMap](../../stock_location_next/types/stock_location_next.OperatorMap/page.mdx)
+- [FilterValue2](../../stock_location_next/types/stock_location_next.FilterValue2/page.mdx)
+- [FilterValue](../../stock_location_next/types/stock_location_next.FilterValue/page.mdx)
+- [PrevLimit](../../stock_location_next/types/stock_location_next.PrevLimit/page.mdx)
+- [FilterQuery](../../stock_location_next/types/stock_location_next.FilterQuery/page.mdx)
+- [MessageBody](../../stock_location_next/types/stock_location_next.MessageBody/page.mdx)
+- [Message](../../stock_location_next/types/stock_location_next.Message/page.mdx)
+- [MessageFormat](../../stock_location_next/types/stock_location_next.MessageFormat/page.mdx)
+- [GeoZoneType](../../stock_location_next/types/stock_location_next.GeoZoneType/page.mdx)
+- [ShippingOptionPriceType](../../stock_location_next/types/stock_location_next.ShippingOptionPriceType/page.mdx)
+- [JoinerRelationship](../../stock_location_next/types/stock_location_next.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../stock_location_next/types/stock_location_next.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../stock_location_next/types/stock_location_next.ModuleJoinerRelationship/page.mdx)
+- [StockLocationAddressDTO](../../stock_location_next/types/stock_location_next.StockLocationAddressDTO/page.mdx)
+- [StockLocationDTO](../../stock_location_next/types/stock_location_next.StockLocationDTO/page.mdx)
+- [StockLocationAddressInput](../../stock_location_next/types/stock_location_next.StockLocationAddressInput/page.mdx)
+- [CreateStockLocationInput](../../stock_location_next/types/stock_location_next.CreateStockLocationInput/page.mdx)
+- [UpdateStockLocationInput](../../stock_location_next/types/stock_location_next.UpdateStockLocationInput/page.mdx)
@@ -0,0 +1,23 @@
+---
+displayed_sidebar: stockLocationNextModelReference
+slug: /references/stock-location-next/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Stock Location Next Module Data Models Reference
+
+This documentation provides a reference to the data models in the Stock Location Next Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	StockLocation }|--|{ StockLocationAddress : address
+
+```
+
+## Classes
+
+- [StockLocationAddress](../../stock_location_next_models/classes/stock_location_next_models.StockLocationAddress/page.mdx)
+- [StockLocation](../../stock_location_next_models/classes/stock_location_next_models.StockLocation/page.mdx)
@@ -0,0 +1,31 @@
+import { TypeList } from "docs-ui"
+
+# store
+
+## Interfaces
+
+- [FindConfig](../../store/interfaces/store.FindConfig/page.mdx)
+- [BaseFilterable](../../store/interfaces/store.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../store/interfaces/store.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../store/interfaces/store.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../store/interfaces/store.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../store/interfaces/store.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../store/interfaces/store.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../store/interfaces/store.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../store/interfaces/store.IMessageAggregator/page.mdx)
+- [Context](../../store/interfaces/store.Context/page.mdx)
+- [StoreDTO](../../store/interfaces/store.StoreDTO/page.mdx)
+- [FilterableStoreProps](../../store/interfaces/store.FilterableStoreProps/page.mdx)
+- [CreateStoreDTO](../../store/interfaces/store.CreateStoreDTO/page.mdx)
+- [UpsertStoreDTO](../../store/interfaces/store.UpsertStoreDTO/page.mdx)
+- [UpdateStoreDTO](../../store/interfaces/store.UpdateStoreDTO/page.mdx)
+- [IStoreModuleService](../../store/interfaces/store.IStoreModuleService/page.mdx)
+
+## Type Aliases
+
+- [MessageBody](../../store/types/store.MessageBody/page.mdx)
+- [Message](../../store/types/store.Message/page.mdx)
+- [MessageFormat](../../store/types/store.MessageFormat/page.mdx)
+- [JoinerRelationship](../../store/types/store.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../store/types/store.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../store/types/store.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,14 @@
+---
+displayed_sidebar: storeModelReference
+slug: /references/store/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Store Module Data Models Reference
+
+This documentation provides a reference to the data models in the Store Module
+
+## Classes
+
+- [Store](../../store_models/classes/store_models.Store/page.mdx)
@@ -0,0 +1,55 @@
+import { TypeList } from "docs-ui"
+
+# tax
+
+## Interfaces
+
+- [FindConfig](../../tax/interfaces/tax.FindConfig/page.mdx)
+- [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../tax/interfaces/tax.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../tax/interfaces/tax.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../tax/interfaces/tax.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../tax/interfaces/tax.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../tax/interfaces/tax.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../tax/interfaces/tax.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../tax/interfaces/tax.IMessageAggregator/page.mdx)
+- [Context](../../tax/interfaces/tax.Context/page.mdx)
+- [TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)
+- [FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)
+- [TaxRegionDTO](../../tax/interfaces/tax.TaxRegionDTO/page.mdx)
+- [FilterableTaxRegionProps](../../tax/interfaces/tax.FilterableTaxRegionProps/page.mdx)
+- [TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)
+- [FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx)
+- [TaxableItemDTO](../../tax/interfaces/tax.TaxableItemDTO/page.mdx)
+- [TaxableShippingDTO](../../tax/interfaces/tax.TaxableShippingDTO/page.mdx)
+- [TaxCalculationContext](../../tax/interfaces/tax.TaxCalculationContext/page.mdx)
+- [TaxLineDTO](../../tax/interfaces/tax.TaxLineDTO/page.mdx)
+- [ItemTaxLineDTO](../../tax/interfaces/tax.ItemTaxLineDTO/page.mdx)
+- [ShippingTaxLineDTO](../../tax/interfaces/tax.ShippingTaxLineDTO/page.mdx)
+- [CreateTaxRateDTO](../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)
+- [UpsertTaxRateDTO](../../tax/interfaces/tax.UpsertTaxRateDTO/page.mdx)
+- [UpdateTaxRateDTO](../../tax/interfaces/tax.UpdateTaxRateDTO/page.mdx)
+- [CreateTaxRegionDTO](../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)
+- [CreateTaxRateRuleDTO](../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)
+- [ITaxModuleService](../../tax/interfaces/tax.ITaxModuleService/page.mdx)
+
+## Type Aliases
+
+- [Query](../../tax/types/tax.Query/page.mdx)
+- [ExpandScalar](../../tax/types/tax.ExpandScalar/page.mdx)
+- [Scalar](../../tax/types/tax.Scalar/page.mdx)
+- [ReadonlyPrimary](../../tax/types/tax.ReadonlyPrimary/page.mdx)
+- [Primary](../../tax/types/tax.Primary/page.mdx)
+- [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)
+- [FilterValue2](../../tax/types/tax.FilterValue2/page.mdx)
+- [FilterValue](../../tax/types/tax.FilterValue/page.mdx)
+- [PrevLimit](../../tax/types/tax.PrevLimit/page.mdx)
+- [FilterQuery](../../tax/types/tax.FilterQuery/page.mdx)
+- [MessageBody](../../tax/types/tax.MessageBody/page.mdx)
+- [Message](../../tax/types/tax.Message/page.mdx)
+- [MessageFormat](../../tax/types/tax.MessageFormat/page.mdx)
+- [JoinerRelationship](../../tax/types/tax.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../tax/types/tax.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../tax/types/tax.ModuleJoinerRelationship/page.mdx)
+- [BigNumberRawValue](../../tax/types/tax.BigNumberRawValue/page.mdx)
+- [BigNumberInput](../../tax/types/tax.BigNumberInput/page.mdx)
@@ -0,0 +1,28 @@
+---
+displayed_sidebar: taxModelReference
+slug: /references/tax/models
+---
+
+import { TypeList } from "docs-ui"
+
+# Tax Module Data Models Reference
+
+This documentation provides a reference to the data models in the Tax Module
+
+## Relations Overview
+
+```mermaid
+erDiagram
+	TaxRate }|--|{ TaxRegion : tax_region
+	TaxRate ||--|| TaxRateRule : rules
+	TaxRegion }|--|{ TaxProvider : provider
+	TaxRegion }|--|{ TaxRegion : parent
+
+```
+
+## Classes
+
+- [TaxProvider](../../tax_models/classes/tax_models.TaxProvider/page.mdx)
+- [TaxRateRule](../../tax_models/classes/tax_models.TaxRateRule/page.mdx)
+- [TaxRate](../../tax_models/classes/tax_models.TaxRate/page.mdx)
+- [TaxRegion](../../tax_models/classes/tax_models.TaxRegion/page.mdx)
@@ -0,0 +1,12 @@
+import { TypeList } from "docs-ui"
+
+# tax-provider
+
+## Interfaces
+
+- [ITaxProvider](../../tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx)
+
+## Type Aliases
+
+- [ShippingTaxCalculationLine](../../tax_provider/types/tax_provider.ShippingTaxCalculationLine/page.mdx)
+- [ItemTaxCalculationLine](../../tax_provider/types/tax_provider.ItemTaxCalculationLine/page.mdx)
@@ -0,0 +1,71 @@
+import { TypeList } from "docs-ui"
+
+# types
+
+## Namespaces
+
+- [CacheTypes](../../types/types.CacheTypes/page.mdx)
+- [CommonTypes](../../types/types.CommonTypes/page.mdx)
+- [DAL](../../types/types.DAL/page.mdx)
+- [EventBusTypes](../../types/types.EventBusTypes/page.mdx)
+- [FeatureFlagTypes](../../types/types.FeatureFlagTypes/page.mdx)
+- [FileTypes](../../types/types.FileTypes/page.mdx)
+- [HttpTypes](../../types/types.HttpTypes/page.mdx)
+- [LoggerTypes](../../types/types.LoggerTypes/page.mdx)
+- [ModulesSdkTypes](../../types/types.ModulesSdkTypes/page.mdx)
+- [RegionTypes](../../types/types.RegionTypes/page.mdx)
+- [SearchTypes](../../types/types.SearchTypes/page.mdx)
+- [TransactionBaseTypes](../../types/types.TransactionBaseTypes/page.mdx)
+- [WorkflowTypes](../../types/types.WorkflowTypes/page.mdx)
+
+## Interfaces
+
+- [SessionOptions](../../types/interfaces/types.SessionOptions/page.mdx)
+- [BaseRepositoryService](../../types/interfaces/types.BaseRepositoryService/page.mdx)
+- [FileServiceUploadResult](../../types/interfaces/types.FileServiceUploadResult/page.mdx)
+- [FileServiceGetUploadStreamResult](../../types/interfaces/types.FileServiceGetUploadStreamResult/page.mdx)
+- [GetUploadedFileType](../../types/interfaces/types.GetUploadedFileType/page.mdx)
+- [DeleteFileType](../../types/interfaces/types.DeleteFileType/page.mdx)
+- [UploadStreamDescriptorType](../../types/interfaces/types.UploadStreamDescriptorType/page.mdx)
+- [PaginatedResponse](../../types/interfaces/types.PaginatedResponse/page.mdx)
+- [ProductCategoryResponse](../../types/interfaces/types.ProductCategoryResponse/page.mdx)
+- [JoinerServiceConfigAlias](../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../types/interfaces/types.JoinerServiceConfig/page.mdx)
+- [JoinerArgument](../../types/interfaces/types.JoinerArgument/page.mdx)
+- [JoinerDirective](../../types/interfaces/types.JoinerDirective/page.mdx)
+- [RemoteJoinerQuery](../../types/interfaces/types.RemoteJoinerQuery/page.mdx)
+- [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions/page.mdx)
+- [RemoteNestedExpands](../../types/interfaces/types.RemoteNestedExpands/page.mdx)
+- [RemoteExpandProperty](../../types/interfaces/types.RemoteExpandProperty/page.mdx)
+- [ILinkModule](../../types/interfaces/types.ILinkModule/page.mdx)
+- [ProductCategoryTransformOptions](../../types/interfaces/types.ProductCategoryTransformOptions/page.mdx)
+- [SharedContext](../../types/interfaces/types.SharedContext/page.mdx)
+- [MessageAggregatorFormat](../../types/interfaces/types.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../types/interfaces/types.IMessageAggregator/page.mdx)
+- [Context](../../types/interfaces/types.Context/page.mdx)
+- [InputPrice](../../types/interfaces/types.InputPrice/page.mdx)
+- [CreateLocationFulfillmentSetWorkflowInputDTO](../../types/interfaces/types.CreateLocationFulfillmentSetWorkflowInputDTO/page.mdx)
+
+## Type Aliases
+
+- [AddressDTO](../../types/types/types.AddressDTO/page.mdx)
+- [Dictionary](../../types/types/types.Dictionary/page.mdx)
+- [Query](../../types/types/types.Query/page.mdx)
+- [ExpandScalar](../../types/types/types.ExpandScalar/page.mdx)
+- [Scalar](../../types/types/types.Scalar/page.mdx)
+- [ReadonlyPrimary](../../types/types/types.ReadonlyPrimary/page.mdx)
+- [Primary](../../types/types/types.Primary/page.mdx)
+- [FilterValue2](../../types/types/types.FilterValue2/page.mdx)
+- [FilterValue](../../types/types/types.FilterValue/page.mdx)
+- [PrevLimit](../../types/types/types.PrevLimit/page.mdx)
+- [Order](../../types/types/types.Order/page.mdx)
+- [JoinerRelationship](../../types/types/types.JoinerRelationship/page.mdx)
+- [ModuleDeclaration](../../types/types/types.ModuleDeclaration/page.mdx)
+- [BigNumberRawValue](../../types/types/types.BigNumberRawValue/page.mdx)
+- [BigNumberInput](../../types/types/types.BigNumberInput/page.mdx)
+- [BigNumberValue](../../types/types/types.BigNumberValue/page.mdx)
+- [CartLikeWithTotals](../../types/types/types.CartLikeWithTotals/page.mdx)
+- [CreateProductVariantWorkflowInputDTO](../../types/types/types.CreateProductVariantWorkflowInputDTO/page.mdx)
+- [UpdateProductVariantWorkflowInputDTO](../../types/types/types.UpdateProductVariantWorkflowInputDTO/page.mdx)
+- [CreateProductWorkflowInputDTO](../../types/types/types.CreateProductWorkflowInputDTO/page.mdx)
+- [UpdateProductWorkflowInputDTO](../../types/types/types.UpdateProductWorkflowInputDTO/page.mdx)
@@ -0,0 +1,33 @@
+import { TypeList } from "docs-ui"
+
+# user
+
+## Interfaces
+
+- [FindConfig](../../user/interfaces/user.FindConfig/page.mdx)
+- [BaseFilterable](../../user/interfaces/user.BaseFilterable/page.mdx)
+- [SoftDeleteReturn](../../user/interfaces/user.SoftDeleteReturn/page.mdx)
+- [RestoreReturn](../../user/interfaces/user.RestoreReturn/page.mdx)
+- [JoinerServiceConfigAlias](../../user/interfaces/user.JoinerServiceConfigAlias/page.mdx)
+- [JoinerServiceConfig](../../user/interfaces/user.JoinerServiceConfig/page.mdx)
+- [IModuleService](../../user/interfaces/user.IModuleService/page.mdx)
+- [MessageAggregatorFormat](../../user/interfaces/user.MessageAggregatorFormat/page.mdx)
+- [IMessageAggregator](../../user/interfaces/user.IMessageAggregator/page.mdx)
+- [Context](../../user/interfaces/user.Context/page.mdx)
+- [UserDTO](../../user/interfaces/user.UserDTO/page.mdx)
+- [FilterableUserProps](../../user/interfaces/user.FilterableUserProps/page.mdx)
+- [InviteDTO](../../user/interfaces/user.InviteDTO/page.mdx)
+- [CreateUserDTO](../../user/interfaces/user.CreateUserDTO/page.mdx)
+- [UpdateUserDTO](../../user/interfaces/user.UpdateUserDTO/page.mdx)
+- [CreateInviteDTO](../../user/interfaces/user.CreateInviteDTO/page.mdx)
+- [UpdateInviteDTO](../../user/interfaces/user.UpdateInviteDTO/page.mdx)
+- [IUserModuleService](../../user/interfaces/user.IUserModuleService/page.mdx)
+
+## Type Aliases
+
+- [MessageBody](../../user/types/user.MessageBody/page.mdx)
+- [Message](../../user/types/user.Message/page.mdx)
+- [MessageFormat](../../user/types/user.MessageFormat/page.mdx)
+- [JoinerRelationship](../../user/types/user.JoinerRelationship/page.mdx)
+- [ModuleJoinerConfig](../../user/types/user.ModuleJoinerConfig/page.mdx)
+- [ModuleJoinerRelationship](../../user/types/user.ModuleJoinerRelationship/page.mdx)
@@ -0,0 +1,15 @@
+---
+displayed_sidebar: userModelReference
+slug: /references/user/models
+---
+
+import { TypeList } from "docs-ui"
+
+# User Module Data Models Reference
+
+This documentation provides a reference to the data models in the User Module
+
+## Classes
+
+- [Invite](../../user_models/classes/user_models.Invite/page.mdx)
+- [User](../../user_models/classes/user_models.User/page.mdx)
@@ -0,0 +1,63 @@
+import { TypeList } from "docs-ui"
+
+# utils
+
+## Namespaces
+
+- [FulfillmentUtils](../../utils/utils.FulfillmentUtils/page.mdx)
+- [InventoryUtils](../../utils/utils.InventoryUtils/page.mdx)
+- [LinkUtils](../../utils/utils.LinkUtils/page.mdx)
+- [OrderUtils](../../utils/utils.OrderUtils/page.mdx)
+- [ProductUtils](../../utils/utils.ProductUtils/page.mdx)
+- [PromotionUtils](../../utils/utils.PromotionUtils/page.mdx)
+- [ShippingProfileUtils](../../utils/utils.ShippingProfileUtils/page.mdx)
+- [UserUtils](../../utils/utils.UserUtils/page.mdx)
+
+## Enumerations
+
+- [PaymentCollectionStatus](../../utils/enums/utils.PaymentCollectionStatus/page.mdx)
+- [PaymentSessionStatus](../../utils/enums/utils.PaymentSessionStatus/page.mdx)
+- [PaymentWebhookEvents](../../utils/enums/utils.PaymentWebhookEvents/page.mdx)
+- [PaymentActions](../../utils/enums/utils.PaymentActions/page.mdx)
+- [PriceListStatus](../../utils/enums/utils.PriceListStatus/page.mdx)
+- [PriceListType](../../utils/enums/utils.PriceListType/page.mdx)
+
+## Type Aliases
+
+- [RuleAttributeInput](../../utils/types/utils.RuleAttributeInput/page.mdx)
+
+___
+
+## Variables
+
+### MedusaModuleType
+
+ `Const` **MedusaModuleType**: typeof [MedusaModuleType](page.mdx#medusamoduletype)
+
+### ReservedPricingRuleAttributes
+
+ `Const` **ReservedPricingRuleAttributes**: `string`[]
+
+___
+
+## Functions
+
+### getInvalidRuleAttributes
+
+#### Parameters
+
+<TypeList types={[{"name":"ruleAttributes","type":"[RuleAttributeInput](../../utils/types/utils.RuleAttributeInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="getInvalidRuleAttributes"/>
+
+#### Returns
+
+<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}  sectionTitle="getInvalidRuleAttributes"/>
+
+### validateRuleAttributes
+
+#### Parameters
+
+<TypeList types={[{"name":"ruleAttributes","type":"[RuleAttributeInput](../../utils/types/utils.RuleAttributeInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="validateRuleAttributes"/>
+
+#### Returns
+
+<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="validateRuleAttributes"/>
@@ -0,0 +1,16 @@
+---
+slug: /references/workflows
+---
+
+import { TypeList } from "docs-ui"
+
+# Workflows API Reference
+
+This section of the documentation provides a reference to the utility functions of the `@medusajs/workflows-sdk` package.
+
+## Functions
+
+- [createStep](../../workflows/functions/workflows.createStep/page.mdx)
+- [createWorkflow](../../workflows/functions/workflows.createWorkflow/page.mdx)
+- [parallelize](../../workflows/functions/workflows.parallelize/page.mdx)
+- [transform](../../workflows/functions/workflows.transform/page.mdx)