chore(docs): Generated References (#5881)

Generated the following references:
- `EventBusTypes`
- `IPricingModuleService`
- `ModulesSdkTypes`
- `PriceListWorkflow`
- `fulfillment`
- `js_client`
- `medusa`
- `modules`
- `pricing`
- `services`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-12-14 18:28:23 +00:00
committed by GitHub
parent fde1e23995
commit 2d127a4c67
272 changed files with 82 additions and 1205 deletions

View File

@@ -13,11 +13,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This documentation provides a reference to the `addPrices` method. This belongs to the Pricing Module.
`**addPrices**(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)&#62;`
## addPrices(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)&#62;
This method adds prices to a price set.
## Example
### Example
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
@@ -88,7 +88,7 @@ async function addPricesToPriceSet (priceSetId: string) {
}
```
## Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -240,7 +240,7 @@ async function addPricesToPriceSet (priceSetId: string) {
}
]} />
## Returns
### Returns
<ParameterTypes parameters={[
{
@@ -383,11 +383,11 @@ async function addPricesToPriceSet (priceSetId: string) {
}
]} />
`**addPrices**(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]&#62;`
## addPrices(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]&#62;
This method adds prices to multiple price sets.
## Example
### Example
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
@@ -458,7 +458,7 @@ async function addPricesToPriceSet (priceSetId: string) {
}
```
## Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -610,7 +610,7 @@ async function addPricesToPriceSet (priceSetId: string) {
}
]} />
## Returns
### Returns
<ParameterTypes parameters={[
{

View File

@@ -13,11 +13,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This documentation provides a reference to the `addRules` method. This belongs to the Pricing Module.
`**addRules**(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)&#62;`
## addRules(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)&#62;
This method adds rules to a price set.
## Example
### Example
```ts
import {
@@ -38,7 +38,7 @@ async function addRulesToPriceSet (priceSetId: string) {
}
```
## Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -136,7 +136,7 @@ async function addRulesToPriceSet (priceSetId: string) {
}
]} />
## Returns
### Returns
<ParameterTypes parameters={[
{
@@ -279,11 +279,11 @@ async function addRulesToPriceSet (priceSetId: string) {
}
]} />
`**addRules**(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]&#62;`
## addRules(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]&#62;
This method adds rules to multiple price sets.
## Example
### Example
```ts
import {
@@ -304,7 +304,7 @@ async function addRulesToPriceSet (priceSetId: string) {
}
```
## Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -402,7 +402,7 @@ async function addRulesToPriceSet (priceSetId: string) {
}
]} />
## Returns
### Returns
<ParameterTypes parameters={[
{

View File

@@ -13,11 +13,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This documentation provides a reference to the `create` method. This belongs to the Pricing Module.
`**create**(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)&#62;`
## create(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)&#62;
This method is used to create a new price set.
## Example
### Example
To create a default price set, don't pass any rules. For example:
@@ -99,7 +99,7 @@ async function createPriceSet () {
}
```
## Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -261,7 +261,7 @@ async function createPriceSet () {
}
]} />
## Returns
### Returns
<ParameterTypes parameters={[
{
@@ -404,11 +404,11 @@ async function createPriceSet () {
}
]} />
`**create**(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]&#62;`
## create(data, sharedContext?): Promise&#60;[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]&#62;
This method is used to create multiple price sets.
## Example
### Example
To create price sets with a default price, don't pass any rules and make sure to pass the `currency_code` of the price. For example:
@@ -483,7 +483,7 @@ async function createPriceSets () {
}
```
## Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -645,7 +645,7 @@ async function createPriceSets () {
}
]} />
## Returns
### Returns
<ParameterTypes parameters={[
{