chore(docs): Generated References (#6904)
Generated the following references: - `inventory` - `js_client` - `medusa` - `medusa_config` - `medusa_react` - `modules` - `payment` - `pricing` - `product` - `services` - `stock_location` - `tax_calculation` - `types` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
85e5478873
commit
7fe164bc1d
File diff suppressed because one or more lines are too long
@@ -34,13 +34,13 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"IPricingModuleService","type":"`object`","description":"The main service interface for the pricing module.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="pricingModuleService"/>
|
||||
<TypeList types={[{"name":"IPricingModuleService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="pricingModuleService"/>
|
||||
|
||||
### remoteQuery
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"RemoteQueryFunction","type":"(`query`: `string` \\| [RemoteJoinerQuery](../../types/interfaces/types.RemoteJoinerQuery.mdx) \\| `object`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions.mdx)) => Promise<any> \\| `null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="remoteQuery"/>
|
||||
<TypeList types={[{"name":"RemoteQueryFunction","type":"(`query`: `string` \\| [RemoteJoinerQuery](../../types/interfaces/types.RemoteJoinerQuery.mdx) \\| `object`, `variables?`: `Record<string, unknown>`) => Promise<any> \\| `null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="remoteQuery"/>
|
||||
|
||||
___
|
||||
|
||||
@@ -109,6 +109,16 @@ Gets the prices for a product variant
|
||||
|
||||
<TypeList types={[{"name":"TaxedPricing","type":"`object`","description":"Pricing fields related to taxes.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="calculateTaxes"/>
|
||||
|
||||
### getProductVariantPricingModulePricing\_
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"variantPriceData","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="getProductVariantPricingModulePricing_"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<Map<any, any>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="getProductVariantPricingModulePricing_"/>
|
||||
|
||||
### getProductVariantPricing\_
|
||||
|
||||
#### Parameters
|
||||
@@ -218,6 +228,16 @@ Set additional prices on a list of products.
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<([Product](../../entities/classes/entities.Product.mdx) \\| [PricedProduct](../../medusa/types/medusa.PricedProduct.mdx))[]>","optional":false,"defaultValue":"","description":"A list of products with variants decorated with prices","expandable":false,"children":[]}]} sectionTitle="setProductPrices"/>
|
||||
|
||||
### getPricingModuleVariantMoneyAmounts
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"variantIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="getPricingModuleVariantMoneyAmounts"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<Map<string, [MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="getPricingModuleVariantMoneyAmounts"/>
|
||||
|
||||
### setAdminVariantPricing
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -32,13 +32,13 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"IInventoryService","type":"`object`","description":"The main service interface for the inventory module.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="inventoryService_"/>
|
||||
<TypeList types={[{"name":"IInventoryService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="inventoryService_"/>
|
||||
|
||||
### stockLocationService\_
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"IStockLocationService","type":"`object`","description":"The main service interface for the stock location's module.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="stockLocationService_"/>
|
||||
<TypeList types={[{"name":"IStockLocationService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="stockLocationService_"/>
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"IInventoryService","type":"`object`","description":"The main service interface for the inventory module.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="inventoryService_"/>
|
||||
<TypeList types={[{"name":"IInventoryService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="inventoryService_"/>
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"IStockLocationService","type":"`object`","description":"The main service interface for the stock location's module.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="stockLocationService_"/>
|
||||
<TypeList types={[{"name":"IStockLocationService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="stockLocationService_"/>
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -116,11 +116,11 @@ Persists the tax lines relevant for an order to the database.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"cartOrLineItems","type":"[Cart](../../entities/classes/entities.Cart.mdx) \\| [LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"the cart or line items to create tax lines for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculationContext","type":"[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)","description":"the calculation context to get tax lines by","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createTaxLines"/>
|
||||
<TypeList types={[{"name":"cartOrLineItems","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[] \\| [Cart](../../entities/classes/entities.Cart.mdx)","description":"the cart or line items to create tax lines for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculationContext","type":"[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)","description":"the calculation context to get tax lines by","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createTaxLines"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<([ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx) \\| [LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} sectionTitle="createTaxLines"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} sectionTitle="createTaxLines"/>
|
||||
|
||||
### createShippingTaxLines
|
||||
|
||||
@@ -133,7 +133,7 @@ for return shipping methods.
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<([ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx) \\| [LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} sectionTitle="createShippingTaxLines"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} sectionTitle="createShippingTaxLines"/>
|
||||
|
||||
### getShippingTaxLines
|
||||
|
||||
@@ -163,7 +163,7 @@ wish to persist the tax lines to the DB layer.
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<([ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx) \\| [LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the computed tax lines","expandable":false,"children":[]}]} sectionTitle="getTaxLines"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the computed tax lines","expandable":false,"children":[]}]} sectionTitle="getTaxLines"/>
|
||||
|
||||
### getTaxLinesMap
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ transaction manager is created.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)<FilterableUserProps> & `object`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<FilterableUserProps>","description":"the configuration object for the query","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"selector","type":"[Selector](../../types/CommonTypes/types/types.CommonTypes.Selector.mdx)<FilterableUserProps> & `object`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<FilterableUserProps>","description":"the configuration object for the query","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -86,7 +86,7 @@ transaction manager is created.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)<FilterableUserProps> & `object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<FilterableUserProps>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="listAndCount"/>
|
||||
<TypeList types={[{"name":"selector","type":"[Selector](../../types/CommonTypes/types/types.CommonTypes.Selector.mdx)<FilterableUserProps> & `object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<FilterableUserProps>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="listAndCount"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
Reference in New Issue
Block a user