docs: enhance how references are generated (#5805)

* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
This commit is contained in:
Shahed Nasser
2023-12-05 15:29:41 +02:00
committed by GitHub
parent a418e6cebc
commit 892d737c1f
4358 changed files with 947876 additions and 534760 deletions
@@ -0,0 +1,116 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# entities
## Enumerations
- [AllocationType](../entities/enums/entities.AllocationType.mdx)
- [CartType](../entities/enums/entities.CartType.mdx)
- [ClaimFulfillmentStatus](../entities/enums/entities.ClaimFulfillmentStatus.mdx)
- [ClaimPaymentStatus](../entities/enums/entities.ClaimPaymentStatus.mdx)
- [ClaimReason](../entities/enums/entities.ClaimReason.mdx)
- [ClaimType](../entities/enums/entities.ClaimType.mdx)
- [DiscountConditionOperator](../entities/enums/entities.DiscountConditionOperator.mdx)
- [DiscountConditionType](../entities/enums/entities.DiscountConditionType.mdx)
- [DiscountRuleType](../entities/enums/entities.DiscountRuleType.mdx)
- [DraftOrderStatus](../entities/enums/entities.DraftOrderStatus.mdx)
- [FulfillmentStatus](../entities/enums/entities.FulfillmentStatus.mdx)
- [OrderEditItemChangeType](../entities/enums/entities.OrderEditItemChangeType.mdx)
- [OrderEditStatus](../entities/enums/entities.OrderEditStatus.mdx)
- [OrderStatus](../entities/enums/entities.OrderStatus.mdx)
- [PaymentCollectionStatus](../entities/enums/entities.PaymentCollectionStatus.mdx)
- [PaymentCollectionType](../entities/enums/entities.PaymentCollectionType.mdx)
- [PaymentSessionStatus](../entities/enums/entities.PaymentSessionStatus.mdx)
- [PaymentStatus](../entities/enums/entities.PaymentStatus.mdx)
- [ProductStatus](../entities/enums/entities.ProductStatus.mdx)
- [RefundReason](../entities/enums/entities.RefundReason.mdx)
- [RequirementType](../entities/enums/entities.RequirementType.mdx)
- [ReturnStatus](../entities/enums/entities.ReturnStatus.mdx)
- [ShippingOptionPriceType](../entities/enums/entities.ShippingOptionPriceType.mdx)
- [ShippingProfileType](../entities/enums/entities.ShippingProfileType.mdx)
- [SwapFulfillmentStatus](../entities/enums/entities.SwapFulfillmentStatus.mdx)
- [SwapPaymentStatus](../entities/enums/entities.SwapPaymentStatus.mdx)
- [UserRoles](../entities/enums/entities.UserRoles.mdx)
## Classes
- [Address](../entities/classes/entities.Address.mdx)
- [AnalyticsConfig](../entities/classes/entities.AnalyticsConfig.mdx)
- [BatchJob](../entities/classes/entities.BatchJob.mdx)
- [Cart](../entities/classes/entities.Cart.mdx)
- [ClaimImage](../entities/classes/entities.ClaimImage.mdx)
- [ClaimItem](../entities/classes/entities.ClaimItem.mdx)
- [ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)
- [ClaimTag](../entities/classes/entities.ClaimTag.mdx)
- [Country](../entities/classes/entities.Country.mdx)
- [Currency](../entities/classes/entities.Currency.mdx)
- [CustomShippingOption](../entities/classes/entities.CustomShippingOption.mdx)
- [Customer](../entities/classes/entities.Customer.mdx)
- [CustomerGroup](../entities/classes/entities.CustomerGroup.mdx)
- [Discount](../entities/classes/entities.Discount.mdx)
- [DiscountCondition](../entities/classes/entities.DiscountCondition.mdx)
- [DiscountConditionCustomerGroup](../entities/classes/entities.DiscountConditionCustomerGroup.mdx)
- [DiscountConditionProduct](../entities/classes/entities.DiscountConditionProduct.mdx)
- [DiscountConditionProductCollection](../entities/classes/entities.DiscountConditionProductCollection.mdx)
- [DiscountConditionProductTag](../entities/classes/entities.DiscountConditionProductTag.mdx)
- [DiscountConditionProductType](../entities/classes/entities.DiscountConditionProductType.mdx)
- [DiscountRule](../entities/classes/entities.DiscountRule.mdx)
- [DraftOrder](../entities/classes/entities.DraftOrder.mdx)
- [Fulfillment](../entities/classes/entities.Fulfillment.mdx)
- [FulfillmentItem](../entities/classes/entities.FulfillmentItem.mdx)
- [FulfillmentProvider](../entities/classes/entities.FulfillmentProvider.mdx)
- [GiftCard](../entities/classes/entities.GiftCard.mdx)
- [GiftCardTransaction](../entities/classes/entities.GiftCardTransaction.mdx)
- [IdempotencyKey](../entities/classes/entities.IdempotencyKey.mdx)
- [Image](../entities/classes/entities.Image.mdx)
- [Invite](../entities/classes/entities.Invite.mdx)
- [LineItem](../entities/classes/entities.LineItem.mdx)
- [LineItemAdjustment](../entities/classes/entities.LineItemAdjustment.mdx)
- [LineItemTaxLine](../entities/classes/entities.LineItemTaxLine.mdx)
- [MoneyAmount](../entities/classes/entities.MoneyAmount.mdx)
- [Note](../entities/classes/entities.Note.mdx)
- [Notification](../entities/classes/entities.Notification.mdx)
- [NotificationProvider](../entities/classes/entities.NotificationProvider.mdx)
- [Oauth](../entities/classes/entities.Oauth.mdx)
- [Order](../entities/classes/entities.Order.mdx)
- [OrderEdit](../entities/classes/entities.OrderEdit.mdx)
- [OrderItemChange](../entities/classes/entities.OrderItemChange.mdx)
- [Payment](../entities/classes/entities.Payment.mdx)
- [PaymentCollection](../entities/classes/entities.PaymentCollection.mdx)
- [PaymentProvider](../entities/classes/entities.PaymentProvider.mdx)
- [PaymentSession](../entities/classes/entities.PaymentSession.mdx)
- [PriceList](../entities/classes/entities.PriceList.mdx)
- [Product](../entities/classes/entities.Product.mdx)
- [ProductCategory](../entities/classes/entities.ProductCategory.mdx)
- [ProductCollection](../entities/classes/entities.ProductCollection.mdx)
- [ProductOption](../entities/classes/entities.ProductOption.mdx)
- [ProductOptionValue](../entities/classes/entities.ProductOptionValue.mdx)
- [ProductTag](../entities/classes/entities.ProductTag.mdx)
- [ProductTaxRate](../entities/classes/entities.ProductTaxRate.mdx)
- [ProductType](../entities/classes/entities.ProductType.mdx)
- [ProductTypeTaxRate](../entities/classes/entities.ProductTypeTaxRate.mdx)
- [ProductVariant](../entities/classes/entities.ProductVariant.mdx)
- [ProductVariantInventoryItem](../entities/classes/entities.ProductVariantInventoryItem.mdx)
- [ProductVariantMoneyAmount](../entities/classes/entities.ProductVariantMoneyAmount.mdx)
- [PublishableApiKey](../entities/classes/entities.PublishableApiKey.mdx)
- [PublishableApiKeySalesChannel](../entities/classes/entities.PublishableApiKeySalesChannel.mdx)
- [Refund](../entities/classes/entities.Refund.mdx)
- [Region](../entities/classes/entities.Region.mdx)
- [Return](../entities/classes/entities.Return.mdx)
- [ReturnItem](../entities/classes/entities.ReturnItem.mdx)
- [ReturnReason](../entities/classes/entities.ReturnReason.mdx)
- [SalesChannel](../entities/classes/entities.SalesChannel.mdx)
- [SalesChannelLocation](../entities/classes/entities.SalesChannelLocation.mdx)
- [ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)
- [ShippingMethodTaxLine](../entities/classes/entities.ShippingMethodTaxLine.mdx)
- [ShippingOption](../entities/classes/entities.ShippingOption.mdx)
- [ShippingOptionRequirement](../entities/classes/entities.ShippingOptionRequirement.mdx)
- [ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)
- [ShippingTaxRate](../entities/classes/entities.ShippingTaxRate.mdx)
- [StagedJob](../entities/classes/entities.StagedJob.mdx)
- [Store](../entities/classes/entities.Store.mdx)
- [Swap](../entities/classes/entities.Swap.mdx)
- [TaxProvider](../entities/classes/entities.TaxProvider.mdx)
- [TaxRate](../entities/classes/entities.TaxRate.mdx)
- [TrackingLink](../entities/classes/entities.TrackingLink.mdx)
- [User](../entities/classes/entities.User.mdx)
@@ -0,0 +1,11 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# fulfillment
## Classes
- [AbstractFulfillmentService](../fulfillment/classes/fulfillment.AbstractFulfillmentService.mdx)
## Interfaces
- [FulfillmentService](../fulfillment/interfaces/fulfillment.FulfillmentService.mdx)
@@ -0,0 +1,31 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# inventory
## Interfaces
- [BulkUpdateInventoryLevelInput](../inventory/interfaces/inventory.BulkUpdateInventoryLevelInput.mdx)
- [CreateInventoryItemInput](../inventory/interfaces/inventory.CreateInventoryItemInput.mdx)
- [CreateInventoryLevelInput](../inventory/interfaces/inventory.CreateInventoryLevelInput.mdx)
- [CreateReservationItemInput](../inventory/interfaces/inventory.CreateReservationItemInput.mdx)
- [FilterableInventoryItemProps](../inventory/interfaces/inventory.FilterableInventoryItemProps.mdx)
- [FilterableInventoryLevelProps](../inventory/interfaces/inventory.FilterableInventoryLevelProps.mdx)
- [FilterableReservationItemProps](../inventory/interfaces/inventory.FilterableReservationItemProps.mdx)
- [FindConfig](../inventory/interfaces/inventory.FindConfig.mdx)
- [IInventoryService](../inventory/interfaces/inventory.IInventoryService.mdx)
- [JoinerServiceConfig](../inventory/interfaces/inventory.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../inventory/interfaces/inventory.JoinerServiceConfigAlias.mdx)
- [NumericalComparisonOperator](../inventory/interfaces/inventory.NumericalComparisonOperator.mdx)
- [SharedContext](../inventory/interfaces/inventory.SharedContext.mdx)
- [StringComparisonOperator](../inventory/interfaces/inventory.StringComparisonOperator.mdx)
- [UpdateInventoryLevelInput](../inventory/interfaces/inventory.UpdateInventoryLevelInput.mdx)
- [UpdateReservationItemInput](../inventory/interfaces/inventory.UpdateReservationItemInput.mdx)
## Type Aliases
- [InventoryItemDTO](../inventory/types/inventory.InventoryItemDTO.mdx)
- [InventoryLevelDTO](../inventory/types/inventory.InventoryLevelDTO.mdx)
- [JoinerRelationship](../inventory/types/inventory.JoinerRelationship.mdx)
- [ModuleJoinerConfig](../inventory/types/inventory.ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](../inventory/types/inventory.ModuleJoinerRelationship.mdx)
- [ReservationItemDTO](../inventory/types/inventory.ReservationItemDTO.mdx)
@@ -0,0 +1,66 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# js-client
## Classes
- [AddressesResource](../js_client/classes/js_client.AddressesResource.mdx)
- [Admin](../js_client/classes/js_client.Admin.mdx)
- [AdminAuthResource](../js_client/classes/js_client.AdminAuthResource.mdx)
- [AdminBatchJobsResource](../js_client/classes/js_client.AdminBatchJobsResource.mdx)
- [AdminCollectionsResource](../js_client/classes/js_client.AdminCollectionsResource.mdx)
- [AdminCurrenciesResource](../js_client/classes/js_client.AdminCurrenciesResource.mdx)
- [AdminCustomResource](../js_client/classes/js_client.AdminCustomResource.mdx)
- [AdminCustomerGroupsResource](../js_client/classes/js_client.AdminCustomerGroupsResource.mdx)
- [AdminCustomersResource](../js_client/classes/js_client.AdminCustomersResource.mdx)
- [AdminDiscountsResource](../js_client/classes/js_client.AdminDiscountsResource.mdx)
- [AdminDraftOrdersResource](../js_client/classes/js_client.AdminDraftOrdersResource.mdx)
- [AdminGiftCardsResource](../js_client/classes/js_client.AdminGiftCardsResource.mdx)
- [AdminInventoryItemsResource](../js_client/classes/js_client.AdminInventoryItemsResource.mdx)
- [AdminInvitesResource](../js_client/classes/js_client.AdminInvitesResource.mdx)
- [AdminNotesResource](../js_client/classes/js_client.AdminNotesResource.mdx)
- [AdminNotificationsResource](../js_client/classes/js_client.AdminNotificationsResource.mdx)
- [AdminOrderEditsResource](../js_client/classes/js_client.AdminOrderEditsResource.mdx)
- [AdminOrdersResource](../js_client/classes/js_client.AdminOrdersResource.mdx)
- [AdminPaymentCollectionsResource](../js_client/classes/js_client.AdminPaymentCollectionsResource.mdx)
- [AdminPaymentsResource](../js_client/classes/js_client.AdminPaymentsResource.mdx)
- [AdminPriceListResource](../js_client/classes/js_client.AdminPriceListResource.mdx)
- [AdminProductCategoriesResource](../js_client/classes/js_client.AdminProductCategoriesResource.mdx)
- [AdminProductTagsResource](../js_client/classes/js_client.AdminProductTagsResource.mdx)
- [AdminProductTypesResource](../js_client/classes/js_client.AdminProductTypesResource.mdx)
- [AdminProductsResource](../js_client/classes/js_client.AdminProductsResource.mdx)
- [AdminPublishableApiKeyResource](../js_client/classes/js_client.AdminPublishableApiKeyResource.mdx)
- [AdminRegionsResource](../js_client/classes/js_client.AdminRegionsResource.mdx)
- [AdminReservationsResource](../js_client/classes/js_client.AdminReservationsResource.mdx)
- [AdminReturnReasonsResource](../js_client/classes/js_client.AdminReturnReasonsResource.mdx)
- [AdminReturnsResource](../js_client/classes/js_client.AdminReturnsResource.mdx)
- [AdminSalesChannelsResource](../js_client/classes/js_client.AdminSalesChannelsResource.mdx)
- [AdminShippingOptionsResource](../js_client/classes/js_client.AdminShippingOptionsResource.mdx)
- [AdminShippingProfilesResource](../js_client/classes/js_client.AdminShippingProfilesResource.mdx)
- [AdminStockLocationsResource](../js_client/classes/js_client.AdminStockLocationsResource.mdx)
- [AdminStoresResource](../js_client/classes/js_client.AdminStoresResource.mdx)
- [AdminSwapsResource](../js_client/classes/js_client.AdminSwapsResource.mdx)
- [AdminTaxRatesResource](../js_client/classes/js_client.AdminTaxRatesResource.mdx)
- [AdminUploadsResource](../js_client/classes/js_client.AdminUploadsResource.mdx)
- [AdminUsersResource](../js_client/classes/js_client.AdminUsersResource.mdx)
- [AdminVariantsResource](../js_client/classes/js_client.AdminVariantsResource.mdx)
- [AuthResource](../js_client/classes/js_client.AuthResource.mdx)
- [CartsResource](../js_client/classes/js_client.CartsResource.mdx)
- [CollectionsResource](../js_client/classes/js_client.CollectionsResource.mdx)
- [CustomersResource](../js_client/classes/js_client.CustomersResource.mdx)
- [GiftCardsResource](../js_client/classes/js_client.GiftCardsResource.mdx)
- [LineItemsResource](../js_client/classes/js_client.LineItemsResource.mdx)
- [OrderEditsResource](../js_client/classes/js_client.OrderEditsResource.mdx)
- [OrdersResource](../js_client/classes/js_client.OrdersResource.mdx)
- [PaymentCollectionsResource](../js_client/classes/js_client.PaymentCollectionsResource.mdx)
- [PaymentMethodsResource](../js_client/classes/js_client.PaymentMethodsResource.mdx)
- [ProductCategoriesResource](../js_client/classes/js_client.ProductCategoriesResource.mdx)
- [ProductTagsResource](../js_client/classes/js_client.ProductTagsResource.mdx)
- [ProductTypesResource](../js_client/classes/js_client.ProductTypesResource.mdx)
- [ProductVariantsResource](../js_client/classes/js_client.ProductVariantsResource.mdx)
- [ProductsResource](../js_client/classes/js_client.ProductsResource.mdx)
- [RegionsResource](../js_client/classes/js_client.RegionsResource.mdx)
- [ReturnReasonsResource](../js_client/classes/js_client.ReturnReasonsResource.mdx)
- [ReturnsResource](../js_client/classes/js_client.ReturnsResource.mdx)
- [ShippingOptionsResource](../js_client/classes/js_client.ShippingOptionsResource.mdx)
- [SwapsResource](../js_client/classes/js_client.SwapsResource.mdx)
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,70 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# pricing
## Enumerations
- [PriceListStatus](../pricing/enums/pricing.PriceListStatus.mdx)
- [PriceListType](../pricing/enums/pricing.PriceListType.mdx)
## Interfaces
- [AddPriceListPricesDTO](../pricing/interfaces/pricing.AddPriceListPricesDTO.mdx)
- [AddPricesDTO](../pricing/interfaces/pricing.AddPricesDTO.mdx)
- [AddRulesDTO](../pricing/interfaces/pricing.AddRulesDTO.mdx)
- [BaseFilterable](../pricing/interfaces/pricing.BaseFilterable.mdx)
- [CalculatedPriceSet](../pricing/interfaces/pricing.CalculatedPriceSet.mdx)
- [Context](../pricing/interfaces/pricing.Context.mdx)
- [CreateCurrencyDTO](../pricing/interfaces/pricing.CreateCurrencyDTO.mdx)
- [CreateMoneyAmountDTO](../pricing/interfaces/pricing.CreateMoneyAmountDTO.mdx)
- [CreatePriceListDTO](../pricing/interfaces/pricing.CreatePriceListDTO.mdx)
- [CreatePriceListRuleDTO](../pricing/interfaces/pricing.CreatePriceListRuleDTO.mdx)
- [CreatePriceListRules](../pricing/interfaces/pricing.CreatePriceListRules.mdx)
- [CreatePriceRuleDTO](../pricing/interfaces/pricing.CreatePriceRuleDTO.mdx)
- [CreatePriceSetDTO](../pricing/interfaces/pricing.CreatePriceSetDTO.mdx)
- [CreatePriceSetMoneyAmountRulesDTO](../pricing/interfaces/pricing.CreatePriceSetMoneyAmountRulesDTO.mdx)
- [CreatePricesDTO](../pricing/interfaces/pricing.CreatePricesDTO.mdx)
- [CreateRuleTypeDTO](../pricing/interfaces/pricing.CreateRuleTypeDTO.mdx)
- [CurrencyDTO](../pricing/interfaces/pricing.CurrencyDTO.mdx)
- [FilterableCurrencyProps](../pricing/interfaces/pricing.FilterableCurrencyProps.mdx)
- [FilterableMoneyAmountProps](../pricing/interfaces/pricing.FilterableMoneyAmountProps.mdx)
- [FilterablePriceListProps](../pricing/interfaces/pricing.FilterablePriceListProps.mdx)
- [FilterablePriceListRuleProps](../pricing/interfaces/pricing.FilterablePriceListRuleProps.mdx)
- [FilterablePriceRuleProps](../pricing/interfaces/pricing.FilterablePriceRuleProps.mdx)
- [FilterablePriceSetMoneyAmountProps](../pricing/interfaces/pricing.FilterablePriceSetMoneyAmountProps.mdx)
- [FilterablePriceSetMoneyAmountRulesProps](../pricing/interfaces/pricing.FilterablePriceSetMoneyAmountRulesProps.mdx)
- [FilterablePriceSetProps](../pricing/interfaces/pricing.FilterablePriceSetProps.mdx)
- [FilterableRuleTypeProps](../pricing/interfaces/pricing.FilterableRuleTypeProps.mdx)
- [FindConfig](../pricing/interfaces/pricing.FindConfig.mdx)
- [IPricingModuleService](../pricing/interfaces/pricing.IPricingModuleService.mdx)
- [JoinerServiceConfig](../pricing/interfaces/pricing.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../pricing/interfaces/pricing.JoinerServiceConfigAlias.mdx)
- [MoneyAmountDTO](../pricing/interfaces/pricing.MoneyAmountDTO.mdx)
- [PriceListDTO](../pricing/interfaces/pricing.PriceListDTO.mdx)
- [PriceListPriceDTO](../pricing/interfaces/pricing.PriceListPriceDTO.mdx)
- [PriceListRuleDTO](../pricing/interfaces/pricing.PriceListRuleDTO.mdx)
- [PriceListRuleValueDTO](../pricing/interfaces/pricing.PriceListRuleValueDTO.mdx)
- [PriceRuleDTO](../pricing/interfaces/pricing.PriceRuleDTO.mdx)
- [PriceSetDTO](../pricing/interfaces/pricing.PriceSetDTO.mdx)
- [PriceSetMoneyAmountDTO](../pricing/interfaces/pricing.PriceSetMoneyAmountDTO.mdx)
- [PriceSetMoneyAmountRulesDTO](../pricing/interfaces/pricing.PriceSetMoneyAmountRulesDTO.mdx)
- [PricingContext](../pricing/interfaces/pricing.PricingContext.mdx)
- [PricingFilters](../pricing/interfaces/pricing.PricingFilters.mdx)
- [RemovePriceListRulesDTO](../pricing/interfaces/pricing.RemovePriceListRulesDTO.mdx)
- [RemovePriceSetRulesDTO](../pricing/interfaces/pricing.RemovePriceSetRulesDTO.mdx)
- [RuleTypeDTO](../pricing/interfaces/pricing.RuleTypeDTO.mdx)
- [SetPriceListRulesDTO](../pricing/interfaces/pricing.SetPriceListRulesDTO.mdx)
- [UpdateCurrencyDTO](../pricing/interfaces/pricing.UpdateCurrencyDTO.mdx)
- [UpdateMoneyAmountDTO](../pricing/interfaces/pricing.UpdateMoneyAmountDTO.mdx)
- [UpdatePriceListDTO](../pricing/interfaces/pricing.UpdatePriceListDTO.mdx)
- [UpdatePriceListRuleDTO](../pricing/interfaces/pricing.UpdatePriceListRuleDTO.mdx)
- [UpdatePriceRuleDTO](../pricing/interfaces/pricing.UpdatePriceRuleDTO.mdx)
- [UpdatePriceSetDTO](../pricing/interfaces/pricing.UpdatePriceSetDTO.mdx)
- [UpdatePriceSetMoneyAmountRulesDTO](../pricing/interfaces/pricing.UpdatePriceSetMoneyAmountRulesDTO.mdx)
- [UpdateRuleTypeDTO](../pricing/interfaces/pricing.UpdateRuleTypeDTO.mdx)
## Type Aliases
- [JoinerRelationship](../pricing/types/pricing.JoinerRelationship.mdx)
- [ModuleJoinerConfig](../pricing/types/pricing.ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](../pricing/types/pricing.ModuleJoinerRelationship.mdx)
@@ -0,0 +1,65 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# product
## Enumerations
- [ProductStatus](../product/enums/product.ProductStatus.mdx)
## Interfaces
- [BaseFilterable](../product/interfaces/product.BaseFilterable.mdx)
- [Context](../product/interfaces/product.Context.mdx)
- [CreateProductCategoryDTO](../product/interfaces/product.CreateProductCategoryDTO.mdx)
- [CreateProductCollectionDTO](../product/interfaces/product.CreateProductCollectionDTO.mdx)
- [CreateProductDTO](../product/interfaces/product.CreateProductDTO.mdx)
- [CreateProductOptionDTO](../product/interfaces/product.CreateProductOptionDTO.mdx)
- [CreateProductTagDTO](../product/interfaces/product.CreateProductTagDTO.mdx)
- [CreateProductTypeDTO](../product/interfaces/product.CreateProductTypeDTO.mdx)
- [CreateProductVariantDTO](../product/interfaces/product.CreateProductVariantDTO.mdx)
- [CreateProductVariantOptionDTO](../product/interfaces/product.CreateProductVariantOptionDTO.mdx)
- [FilterableProductCategoryProps](../product/interfaces/product.FilterableProductCategoryProps.mdx)
- [FilterableProductCollectionProps](../product/interfaces/product.FilterableProductCollectionProps.mdx)
- [FilterableProductOptionProps](../product/interfaces/product.FilterableProductOptionProps.mdx)
- [FilterableProductProps](../product/interfaces/product.FilterableProductProps.mdx)
- [FilterableProductTagProps](../product/interfaces/product.FilterableProductTagProps.mdx)
- [FilterableProductTypeProps](../product/interfaces/product.FilterableProductTypeProps.mdx)
- [FilterableProductVariantProps](../product/interfaces/product.FilterableProductVariantProps.mdx)
- [FindConfig](../product/interfaces/product.FindConfig.mdx)
- [IProductModuleService](../product/interfaces/product.IProductModuleService.mdx)
- [JoinerServiceConfig](../product/interfaces/product.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../product/interfaces/product.JoinerServiceConfigAlias.mdx)
- [ProductCategoryDTO](../product/interfaces/product.ProductCategoryDTO.mdx)
- [ProductCollectionDTO](../product/interfaces/product.ProductCollectionDTO.mdx)
- [ProductDTO](../product/interfaces/product.ProductDTO.mdx)
- [ProductImageDTO](../product/interfaces/product.ProductImageDTO.mdx)
- [ProductOptionDTO](../product/interfaces/product.ProductOptionDTO.mdx)
- [ProductOptionValueDTO](../product/interfaces/product.ProductOptionValueDTO.mdx)
- [ProductTagDTO](../product/interfaces/product.ProductTagDTO.mdx)
- [ProductTypeDTO](../product/interfaces/product.ProductTypeDTO.mdx)
- [ProductVariantDTO](../product/interfaces/product.ProductVariantDTO.mdx)
- [RestoreReturn](../product/interfaces/product.RestoreReturn.mdx)
- [SoftDeleteReturn](../product/interfaces/product.SoftDeleteReturn.mdx)
- [UpdateProductCategoryDTO](../product/interfaces/product.UpdateProductCategoryDTO.mdx)
- [UpdateProductCollectionDTO](../product/interfaces/product.UpdateProductCollectionDTO.mdx)
- [UpdateProductDTO](../product/interfaces/product.UpdateProductDTO.mdx)
- [UpdateProductOptionDTO](../product/interfaces/product.UpdateProductOptionDTO.mdx)
- [UpdateProductTagDTO](../product/interfaces/product.UpdateProductTagDTO.mdx)
- [UpdateProductTypeDTO](../product/interfaces/product.UpdateProductTypeDTO.mdx)
- [UpdateProductVariantDTO](../product/interfaces/product.UpdateProductVariantDTO.mdx)
## Type Aliases
- [ExpandScalar](../product/types/product.ExpandScalar.mdx)
- [FilterQuery](../product/types/product.FilterQuery.mdx)
- [FilterValue](../product/types/product.FilterValue.mdx)
- [FilterValue2](../product/types/product.FilterValue2.mdx)
- [JoinerRelationship](../product/types/product.JoinerRelationship.mdx)
- [ModuleJoinerConfig](../product/types/product.ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](../product/types/product.ModuleJoinerRelationship.mdx)
- [OperatorMap](../product/types/product.OperatorMap.mdx)
- [PrevLimit](../product/types/product.PrevLimit.mdx)
- [Primary](../product/types/product.Primary.mdx)
- [Query](../product/types/product.Query.mdx)
- [ReadonlyPrimary](../product/types/product.ReadonlyPrimary.mdx)
- [Scalar](../product/types/product.Scalar.mdx)
@@ -0,0 +1,64 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# services
## Classes
- [AnalyticsConfigService](../services/classes/services.AnalyticsConfigService.mdx)
- [AuthService](../services/classes/services.AuthService.mdx)
- [BatchJobService](../services/classes/services.BatchJobService.mdx)
- [CartService](../services/classes/services.CartService.mdx)
- [ClaimItemService](../services/classes/services.ClaimItemService.mdx)
- [ClaimService](../services/classes/services.ClaimService.mdx)
- [CurrencyService](../services/classes/services.CurrencyService.mdx)
- [CustomShippingOptionService](../services/classes/services.CustomShippingOptionService.mdx)
- [CustomerGroupService](../services/classes/services.CustomerGroupService.mdx)
- [CustomerService](../services/classes/services.CustomerService.mdx)
- [DiscountConditionService](../services/classes/services.DiscountConditionService.mdx)
- [DiscountService](../services/classes/services.DiscountService.mdx)
- [DraftOrderService](../services/classes/services.DraftOrderService.mdx)
- [EventBusService](../services/classes/services.EventBusService.mdx)
- [FulfillmentProviderService](../services/classes/services.FulfillmentProviderService.mdx)
- [FulfillmentService](../services/classes/services.FulfillmentService.mdx)
- [GiftCardService](../services/classes/services.GiftCardService.mdx)
- [IdempotencyKeyService](../services/classes/services.IdempotencyKeyService.mdx)
- [LineItemAdjustmentService](../services/classes/services.LineItemAdjustmentService.mdx)
- [LineItemService](../services/classes/services.LineItemService.mdx)
- [MiddlewareService](../services/classes/services.MiddlewareService.mdx)
- [NewTotalsService](../services/classes/services.NewTotalsService.mdx)
- [NoteService](../services/classes/services.NoteService.mdx)
- [NotificationService](../services/classes/services.NotificationService.mdx)
- [OauthService](../services/classes/services.OauthService.mdx)
- [OrderEditItemChangeService](../services/classes/services.OrderEditItemChangeService.mdx)
- [OrderEditService](../services/classes/services.OrderEditService.mdx)
- [OrderService](../services/classes/services.OrderService.mdx)
- [PaymentCollectionService](../services/classes/services.PaymentCollectionService.mdx)
- [PaymentProviderService](../services/classes/services.PaymentProviderService.mdx)
- [PaymentService](../services/classes/services.PaymentService.mdx)
- [PriceListService](../services/classes/services.PriceListService.mdx)
- [PricingService](../services/classes/services.PricingService.mdx)
- [ProductCategoryService](../services/classes/services.ProductCategoryService.mdx)
- [ProductCollectionService](../services/classes/services.ProductCollectionService.mdx)
- [ProductService](../services/classes/services.ProductService.mdx)
- [ProductTypeService](../services/classes/services.ProductTypeService.mdx)
- [ProductVariantInventoryService](../services/classes/services.ProductVariantInventoryService.mdx)
- [ProductVariantService](../services/classes/services.ProductVariantService.mdx)
- [RegionService](../services/classes/services.RegionService.mdx)
- [ReturnReasonService](../services/classes/services.ReturnReasonService.mdx)
- [ReturnService](../services/classes/services.ReturnService.mdx)
- [SalesChannelInventoryService](../services/classes/services.SalesChannelInventoryService.mdx)
- [SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)
- [SalesChannelService](../services/classes/services.SalesChannelService.mdx)
- [SearchService](../services/classes/services.SearchService.mdx)
- [ShippingOptionService](../services/classes/services.ShippingOptionService.mdx)
- [ShippingProfileService](../services/classes/services.ShippingProfileService.mdx)
- [StagedJobService](../services/classes/services.StagedJobService.mdx)
- [StoreService](../services/classes/services.StoreService.mdx)
- [StrategyResolverService](../services/classes/services.StrategyResolverService.mdx)
- [SwapService](../services/classes/services.SwapService.mdx)
- [SystemPaymentProviderService](../services/classes/services.SystemPaymentProviderService.mdx)
- [TaxProviderService](../services/classes/services.TaxProviderService.mdx)
- [TaxRateService](../services/classes/services.TaxRateService.mdx)
- [TokenService](../services/classes/services.TokenService.mdx)
- [TotalsService](../services/classes/services.TotalsService.mdx)
- [UserService](../services/classes/services.UserService.mdx)
@@ -0,0 +1,24 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# stock-location
## Interfaces
- [FilterableStockLocationProps](../stock_location/interfaces/stock_location.FilterableStockLocationProps.mdx)
- [FindConfig](../stock_location/interfaces/stock_location.FindConfig.mdx)
- [IStockLocationService](../stock_location/interfaces/stock_location.IStockLocationService.mdx)
- [JoinerServiceConfig](../stock_location/interfaces/stock_location.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../stock_location/interfaces/stock_location.JoinerServiceConfigAlias.mdx)
- [SharedContext](../stock_location/interfaces/stock_location.SharedContext.mdx)
- [StringComparisonOperator](../stock_location/interfaces/stock_location.StringComparisonOperator.mdx)
## Type Aliases
- [CreateStockLocationInput](../stock_location/types/stock_location.CreateStockLocationInput.mdx)
- [JoinerRelationship](../stock_location/types/stock_location.JoinerRelationship.mdx)
- [ModuleJoinerConfig](../stock_location/types/stock_location.ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](../stock_location/types/stock_location.ModuleJoinerRelationship.mdx)
- [StockLocationAddressDTO](../stock_location/types/stock_location.StockLocationAddressDTO.mdx)
- [StockLocationAddressInput](../stock_location/types/stock_location.StockLocationAddressInput.mdx)
- [StockLocationDTO](../stock_location/types/stock_location.StockLocationDTO.mdx)
- [UpdateStockLocationInput](../stock_location/types/stock_location.UpdateStockLocationInput.mdx)
@@ -0,0 +1,119 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# types
## Namespaces
- [CacheTypes](../types/modules/types.CacheTypes.mdx)
- [CommonTypes](../types/modules/types.CommonTypes.mdx)
- [DAL](../types/modules/types.DAL.mdx)
- [EventBusTypes](../types/modules/types.EventBusTypes.mdx)
- [FeatureFlagTypes](../types/modules/types.FeatureFlagTypes.mdx)
- [LoggerTypes](../types/modules/types.LoggerTypes.mdx)
- [ModulesSdkTypes](../types/modules/types.ModulesSdkTypes.mdx)
- [SalesChannelTypes](../types/modules/types.SalesChannelTypes.mdx)
- [SearchTypes](../types/modules/types.SearchTypes.mdx)
- [TransactionBaseTypes](../types/modules/types.TransactionBaseTypes.mdx)
- [WorkflowTypes](../types/modules/types.WorkflowTypes.mdx)
## Enumerations
- [PriceListStatus](../types/enums/types.PriceListStatus.mdx)
- [PriceListType](../types/enums/types.PriceListType.mdx)
## Interfaces
- [AddPriceListPricesDTO](../types/interfaces/types.AddPriceListPricesDTO.mdx)
- [AddPricesDTO](../types/interfaces/types.AddPricesDTO.mdx)
- [AddRulesDTO](../types/interfaces/types.AddRulesDTO.mdx)
- [BaseRepositoryService](../types/interfaces/types.BaseRepositoryService.mdx)
- [CalculatedPriceSet](../types/interfaces/types.CalculatedPriceSet.mdx)
- [CalculatedPriceSetDTO](../types/interfaces/types.CalculatedPriceSetDTO.mdx)
- [Context](../types/interfaces/types.Context.mdx)
- [CreateCurrencyDTO](../types/interfaces/types.CreateCurrencyDTO.mdx)
- [CreateMoneyAmountDTO](../types/interfaces/types.CreateMoneyAmountDTO.mdx)
- [CreatePriceListDTO](../types/interfaces/types.CreatePriceListDTO.mdx)
- [CreatePriceListRuleDTO](../types/interfaces/types.CreatePriceListRuleDTO.mdx)
- [CreatePriceListRuleValueDTO](../types/interfaces/types.CreatePriceListRuleValueDTO.mdx)
- [CreatePriceListRules](../types/interfaces/types.CreatePriceListRules.mdx)
- [CreatePriceRuleDTO](../types/interfaces/types.CreatePriceRuleDTO.mdx)
- [CreatePriceSetDTO](../types/interfaces/types.CreatePriceSetDTO.mdx)
- [CreatePriceSetMoneyAmountDTO](../types/interfaces/types.CreatePriceSetMoneyAmountDTO.mdx)
- [CreatePriceSetMoneyAmountRulesDTO](../types/interfaces/types.CreatePriceSetMoneyAmountRulesDTO.mdx)
- [CreatePriceSetRuleTypeDTO](../types/interfaces/types.CreatePriceSetRuleTypeDTO.mdx)
- [CreatePricesDTO](../types/interfaces/types.CreatePricesDTO.mdx)
- [CreateRuleTypeDTO](../types/interfaces/types.CreateRuleTypeDTO.mdx)
- [CurrencyDTO](../types/interfaces/types.CurrencyDTO.mdx)
- [FilterableCurrencyProps](../types/interfaces/types.FilterableCurrencyProps.mdx)
- [FilterableMoneyAmountProps](../types/interfaces/types.FilterableMoneyAmountProps.mdx)
- [FilterablePriceListProps](../types/interfaces/types.FilterablePriceListProps.mdx)
- [FilterablePriceListRuleProps](../types/interfaces/types.FilterablePriceListRuleProps.mdx)
- [FilterablePriceListRuleValueProps](../types/interfaces/types.FilterablePriceListRuleValueProps.mdx)
- [FilterablePriceRuleProps](../types/interfaces/types.FilterablePriceRuleProps.mdx)
- [FilterablePriceSetMoneyAmountProps](../types/interfaces/types.FilterablePriceSetMoneyAmountProps.mdx)
- [FilterablePriceSetMoneyAmountRulesProps](../types/interfaces/types.FilterablePriceSetMoneyAmountRulesProps.mdx)
- [FilterablePriceSetProps](../types/interfaces/types.FilterablePriceSetProps.mdx)
- [FilterablePriceSetRuleTypeProps](../types/interfaces/types.FilterablePriceSetRuleTypeProps.mdx)
- [FilterableRuleTypeProps](../types/interfaces/types.FilterableRuleTypeProps.mdx)
- [ILinkModule](../types/interfaces/types.ILinkModule.mdx)
- [InputPrice](../types/interfaces/types.InputPrice.mdx)
- [JoinerArgument](../types/interfaces/types.JoinerArgument.mdx)
- [JoinerDirective](../types/interfaces/types.JoinerDirective.mdx)
- [JoinerServiceConfig](../types/interfaces/types.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../types/interfaces/types.JoinerServiceConfigAlias.mdx)
- [MoneyAmountDTO](../types/interfaces/types.MoneyAmountDTO.mdx)
- [PriceListDTO](../types/interfaces/types.PriceListDTO.mdx)
- [PriceListPriceDTO](../types/interfaces/types.PriceListPriceDTO.mdx)
- [PriceListRuleDTO](../types/interfaces/types.PriceListRuleDTO.mdx)
- [PriceListRuleValueDTO](../types/interfaces/types.PriceListRuleValueDTO.mdx)
- [PriceRuleDTO](../types/interfaces/types.PriceRuleDTO.mdx)
- [PriceSetDTO](../types/interfaces/types.PriceSetDTO.mdx)
- [PriceSetMoneyAmountDTO](../types/interfaces/types.PriceSetMoneyAmountDTO.mdx)
- [PriceSetMoneyAmountRulesDTO](../types/interfaces/types.PriceSetMoneyAmountRulesDTO.mdx)
- [PriceSetRuleTypeDTO](../types/interfaces/types.PriceSetRuleTypeDTO.mdx)
- [PricingContext](../types/interfaces/types.PricingContext.mdx)
- [PricingFilters](../types/interfaces/types.PricingFilters.mdx)
- [ProductCategoryTransformOptions](../types/interfaces/types.ProductCategoryTransformOptions.mdx)
- [RemoteExpandProperty](../types/interfaces/types.RemoteExpandProperty.mdx)
- [RemoteJoinerQuery](../types/interfaces/types.RemoteJoinerQuery.mdx)
- [RemoteNestedExpands](../types/interfaces/types.RemoteNestedExpands.mdx)
- [RemovePriceListRulesDTO](../types/interfaces/types.RemovePriceListRulesDTO.mdx)
- [RemovePriceSetRulesDTO](../types/interfaces/types.RemovePriceSetRulesDTO.mdx)
- [RuleTypeDTO](../types/interfaces/types.RuleTypeDTO.mdx)
- [SetPriceListRulesDTO](../types/interfaces/types.SetPriceListRulesDTO.mdx)
- [SharedContext](../types/interfaces/types.SharedContext.mdx)
- [UpdateCurrencyDTO](../types/interfaces/types.UpdateCurrencyDTO.mdx)
- [UpdateMoneyAmountDTO](../types/interfaces/types.UpdateMoneyAmountDTO.mdx)
- [UpdatePriceListDTO](../types/interfaces/types.UpdatePriceListDTO.mdx)
- [UpdatePriceListRuleDTO](../types/interfaces/types.UpdatePriceListRuleDTO.mdx)
- [UpdatePriceListRuleValueDTO](../types/interfaces/types.UpdatePriceListRuleValueDTO.mdx)
- [UpdatePriceRuleDTO](../types/interfaces/types.UpdatePriceRuleDTO.mdx)
- [UpdatePriceSetDTO](../types/interfaces/types.UpdatePriceSetDTO.mdx)
- [UpdatePriceSetMoneyAmountDTO](../types/interfaces/types.UpdatePriceSetMoneyAmountDTO.mdx)
- [UpdatePriceSetMoneyAmountRulesDTO](../types/interfaces/types.UpdatePriceSetMoneyAmountRulesDTO.mdx)
- [UpdatePriceSetRuleTypeDTO](../types/interfaces/types.UpdatePriceSetRuleTypeDTO.mdx)
- [UpdateRuleTypeDTO](../types/interfaces/types.UpdateRuleTypeDTO.mdx)
## Type Aliases
- [AddressDTO](../types/types/types.AddressDTO.mdx)
- [CartDTO](../types/types/types.CartDTO.mdx)
- [DeleteFileType](../types/types/types.DeleteFileType.mdx)
- [Dictionary](../types/types/types.Dictionary.mdx)
- [ExpandScalar](../types/types/types.ExpandScalar.mdx)
- [FileServiceGetUploadStreamResult](../types/types/types.FileServiceGetUploadStreamResult.mdx)
- [FileServiceUploadResult](../types/types/types.FileServiceUploadResult.mdx)
- [FilterValue](../types/types/types.FilterValue.mdx)
- [FilterValue2](../types/types/types.FilterValue2.mdx)
- [GetUploadedFileType](../types/types/types.GetUploadedFileType.mdx)
- [JoinerRelationship](../types/types/types.JoinerRelationship.mdx)
- [ModuleDeclaration](../types/types/types.ModuleDeclaration.mdx)
- [OperatorMap](../types/types/types.OperatorMap.mdx)
- [Order](../types/types/types.Order.mdx)
- [PrevLimit](../types/types/types.PrevLimit.mdx)
- [Primary](../types/types/types.Primary.mdx)
- [Query](../types/types/types.Query.mdx)
- [ReadonlyPrimary](../types/types/types.ReadonlyPrimary.mdx)
- [Scalar](../types/types/types.Scalar.mdx)
- [SessionOptions](../types/types/types.SessionOptions.mdx)
- [UploadStreamDescriptorType](../types/types/types.UploadStreamDescriptorType.mdx)
@@ -0,0 +1,17 @@
---
displayed_sidebar: workflowsSidebar
slug: /references/workflows
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# 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.mdx)
- [createWorkflow](../workflows/functions/workflows.createWorkflow.mdx)
- [parallelize](../workflows/functions/workflows.parallelize.mdx)
- [transform](../workflows/functions/workflows.transform.mdx)