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]andShahed Nasser authored and GitHub committed 2023-12-14 18:28:23 +00:00
1 parent fde1e23995
commit 2d127a4c67
272 files changed
+82 -1205

No files matched your search

+6 -1
View File
@@ -221,9 +221,14 @@ module.exports = {
"https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records", "https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records",
}, },
}, },
"^medusa/classes/medusa\\.(Store*|Admin*)": {
reflectionGroups: {
Constructors: false,
},
},
// PRICING CONFIG // PRICING CONFIG
"^pricing": { "^(pricing|IPricingModuleService)": {
...modulesOptions, ...modulesOptions,
frontmatterData: { frontmatterData: {
displayed_sidebar: "pricingReference", displayed_sidebar: "pricingReference",
@@ -91,7 +91,7 @@ export function registerHelpers(theme: MarkdownTheme) {
ifShowBreadcrumbsHelper(theme) ifShowBreadcrumbsHelper(theme)
ifShowNamedAnchorsHelper(theme) ifShowNamedAnchorsHelper(theme)
ifShowPageTitleHelper(theme) ifShowPageTitleHelper(theme)
ifShowReturnsHelper() ifShowReturnsHelper(theme)
ifShowTypeHierarchyHelper() ifShowTypeHierarchyHelper()
indexSignatureTitleHelper() indexSignatureTitleHelper()
parameterTableHelper() parameterTableHelper()
@@ -126,6 +126,6 @@ export function registerHelpers(theme: MarkdownTheme) {
featureFlagHelper() featureFlagHelper()
decrementCurrentTitleLevelHelper(theme) decrementCurrentTitleLevelHelper(theme)
incrementCurrentTitleLevelHelper(theme) incrementCurrentTitleLevelHelper(theme)
hasMoreThanOneSignatureHelper() hasMoreThanOneSignatureHelper(theme)
ifCanShowConstructorsTitleHelper() ifCanShowConstructorsTitleHelper()
} }
@@ -1,10 +1,13 @@
import { DeclarationReflection } from "typedoc" import { DeclarationReflection } from "typedoc"
import * as Handlebars from "handlebars" import * as Handlebars from "handlebars"
import getCorrectDeclarationReflection from "../../utils/get-correct-declaration-reflection"
import { MarkdownTheme } from "../../theme"
export default function () { export default function (theme: MarkdownTheme) {
Handlebars.registerHelper( Handlebars.registerHelper(
"hasMoreThanOneSignature", "hasMoreThanOneSignature",
function (model: DeclarationReflection) { function (model: DeclarationReflection) {
model = getCorrectDeclarationReflection(model, theme) || model
return (model?.signatures?.length || 0) > 1 return (model?.signatures?.length || 0) > 1
} }
) )
@@ -1,10 +1,14 @@
import * as Handlebars from "handlebars" import * as Handlebars from "handlebars"
import { ReflectionKind, SignatureReflection } from "typedoc" import { ReflectionKind, SignatureReflection } from "typedoc"
import getCorrectDeclarationReflection from "../../utils/get-correct-declaration-reflection"
import { MarkdownTheme } from "../../theme"
export default function () { export default function (theme: MarkdownTheme) {
Handlebars.registerHelper( Handlebars.registerHelper(
"ifShowReturns", "ifShowReturns",
function (this: SignatureReflection, options: Handlebars.HelperOptions) { function (this: SignatureReflection, options: Handlebars.HelperOptions) {
this.parent =
getCorrectDeclarationReflection(this.parent, theme) || this.parent
return this.type && !this.parent?.kindOf(ReflectionKind.Constructor) return this.type && !this.parent?.kindOf(ReflectionKind.Constructor)
? options.fn(this) ? options.fn(this)
: options.inverse(this) : options.inverse(this)
@@ -7,6 +7,7 @@ import {
import { memberSymbol } from "../../utils" import { memberSymbol } from "../../utils"
import { MarkdownTheme } from "../../theme" import { MarkdownTheme } from "../../theme"
import { getHTMLChar } from "utils" import { getHTMLChar } from "utils"
import getCorrectDeclarationReflection from "../../utils/get-correct-declaration-reflection"
export default function (theme: MarkdownTheme) { export default function (theme: MarkdownTheme) {
Handlebars.registerHelper( Handlebars.registerHelper(
@@ -14,6 +15,8 @@ export default function (theme: MarkdownTheme) {
function (this: SignatureReflection, accessor?: string, standalone = true) { function (this: SignatureReflection, accessor?: string, standalone = true) {
const { sections, expandMembers = false } = const { sections, expandMembers = false } =
theme.getFormattingOptionsForLocation() theme.getFormattingOptionsForLocation()
this.parent =
getCorrectDeclarationReflection(this.parent, theme) || this.parent
const parentHasMoreThanOneSignature = const parentHasMoreThanOneSignature =
Handlebars.helpers.hasMoreThanOneSignature(this.parent) Handlebars.helpers.hasMoreThanOneSignature(this.parent)
if ( if (
@@ -24,6 +27,7 @@ export default function (theme: MarkdownTheme) {
// only show title if there are more than one signatures // only show title if there are more than one signatures
return "" return ""
} }
const md: string[] = [] const md: string[] = []
if (!expandMembers) { if (!expandMembers) {
@@ -70,7 +70,7 @@
{{incrementCurrentTitleLevel}} {{incrementCurrentTitleLevel}}
{{> member.signature showSources=false }} {{> member.signature showSources=false parent=../type.declaration }}
{{decrementCurrentTitleLevel}} {{decrementCurrentTitleLevel}}
@@ -16,7 +16,7 @@
{{#each signatures}} {{#each signatures}}
{{> member.signature showSources=true }} {{> member.signature showSources=true parent=.. }}
{{/each}} {{/each}}
@@ -1,4 +1,4 @@
{{{signatureTitle accessor}}} {{{signatureTitle accessor parent}}}
{{#if (getFormattingOption "expandMembers")}} {{#if (getFormattingOption "expandMembers")}}
@@ -90,7 +90,7 @@
{{#each declaration.signatures}} {{#each declaration.signatures}}
{{> member.signature showSources=false }} {{> member.signature showSources=false parent=../declaration }}
{{/each}} {{/each}}
@@ -0,0 +1,33 @@
import { DeclarationReflection } from "typedoc"
import { MarkdownTheme } from "../theme"
/**
* Some reflections are loaded as objects rather than instances
* of DeclarationReflection. This tries to reload the declaration reflection
* if that's the case.
*/
export default function getCorrectDeclarationReflection(
refl: unknown,
theme: MarkdownTheme
): DeclarationReflection | undefined {
if (
refl &&
!(refl instanceof DeclarationReflection) &&
typeof refl === "object" &&
"id" in refl &&
refl.id
) {
if (theme.reflection?.id === refl.id) {
refl = theme.reflection!
} else {
refl =
(theme.project?.getReflectionById(
refl.id as number
) as DeclarationReflection) || refl
}
} else if (!refl && theme.reflection) {
refl = theme.reflection
}
return refl as DeclarationReflection | undefined
}
@@ -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. 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. 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`: 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={[ <ParameterTypes parameters={[
{ {
@@ -240,7 +240,7 @@ async function addPricesToPriceSet (priceSetId: string) {
} }
]} /> ]} />
## Returns ### Returns
<ParameterTypes parameters={[ <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. 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`: 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={[ <ParameterTypes parameters={[
{ {
@@ -610,7 +610,7 @@ async function addPricesToPriceSet (priceSetId: string) {
} }
]} /> ]} />
## Returns ### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -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. 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. This method adds rules to a price set.
## Example ### Example
```ts ```ts
import { import {
@@ -38,7 +38,7 @@ async function addRulesToPriceSet (priceSetId: string) {
} }
``` ```
## Parameters ### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -136,7 +136,7 @@ async function addRulesToPriceSet (priceSetId: string) {
} }
]} /> ]} />
## Returns ### Returns
<ParameterTypes parameters={[ <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. This method adds rules to multiple price sets.
## Example ### Example
```ts ```ts
import { import {
@@ -304,7 +304,7 @@ async function addRulesToPriceSet (priceSetId: string) {
} }
``` ```
## Parameters ### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -402,7 +402,7 @@ async function addRulesToPriceSet (priceSetId: string) {
} }
]} /> ]} />
## Returns ### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -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. 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. 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: To create a default price set, don't pass any rules. For example:
@@ -99,7 +99,7 @@ async function createPriceSet () {
} }
``` ```
## Parameters ### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -261,7 +261,7 @@ async function createPriceSet () {
} }
]} /> ]} />
## Returns ### Returns
<ParameterTypes parameters={[ <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. 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: 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={[ <ParameterTypes parameters={[
{ {
@@ -645,7 +645,7 @@ async function createPriceSets () {
} }
]} /> ]} />
## Returns ### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Details of the discount condition to create. Details of the discount condition to create.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminCreateUserRequest # AdminCreateUserRequest
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteCustomerGroupsGroupCustomerBatchReq # AdminDeleteCustomerGroupsGroupCustomerBatchReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The resources to remove. The resources to remove.
## constructor
The resources to remove.
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeletePriceListPricesPricesReq # AdminDeletePriceListPricesPricesReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeletePriceListsPriceListProductsPricesBatchReq # AdminDeletePriceListsPriceListProductsPricesBatchReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteProductCategoriesCategoryProductsBatchReq # AdminDeleteProductCategoriesCategoryProductsBatchReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteProductsFromCollectionReq # AdminDeleteProductsFromCollectionReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeletePublishableApiKeySalesChannelsBatchReq # AdminDeletePublishableApiKeySalesChannelsBatchReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteSalesChannelsChannelProductsBatchReq # AdminDeleteSalesChannelsChannelProductsBatchReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteSalesChannelsChannelStockLocationsReq # AdminDeleteSalesChannelsChannelStockLocationsReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Product types to remove from the tax rates. Product types to remove from the tax rates.
## constructor
Product types to remove from the tax rates.
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteTaxRatesTaxRateProductsReq # AdminDeleteTaxRatesTaxRateProductsReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteTaxRatesTaxRateShippingOptionsReq # AdminDeleteTaxRatesTaxRateShippingOptionsReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteUploadsReq # AdminDeleteUploadsReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Request parameters used to configure and paginate retrieved batch jobs. Request parameters used to configure and paginate retrieved batch jobs.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure pagination of the retrieved batch jobs. Parameters used to filter and configure pagination of the retrieved batch jobs.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to configure the pagination of the retrieved product collections. Parameters used to configure the pagination of the retrieved product collections.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product collections. Parameters used to filter and configure the pagination of the retrieved product collections.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved currencies. Parameters used to filter and configure the pagination of the retrieved currencies.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved customer groups. Parameters used to filter and configure the pagination of the retrieved customer groups.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved customers. Parameters used to filter and configure the pagination of the retrieved customers.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on discounts' rules. Filters to apply on discounts' rules.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved discounts. Parameters used to filter and configure the pagination of the retrieved discounts.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved draft orders. Parameters used to filter and configure the pagination of the retrieved draft orders.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved gift cards. Parameters used to filter and configure the pagination of the retrieved gift cards.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved inventory items. Parameters used to filter and configure the pagination of the retrieved inventory items.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved notes. Parameters used to filter and configure the pagination of the retrieved notes.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved notifications. Parameters used to filter and configure the pagination of the retrieved notifications.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved orders. Parameters used to filter and configure the pagination of the retrieved orders.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved price lists. Parameters used to filter and configure the pagination of the retrieved price lists.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved products associated with a price list. Parameters used to filter and configure the pagination of the retrieved products associated with a price list.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product categories. Parameters used to filter and configure the pagination of the retrieved product categories.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated. Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product tags. Parameters used to filter and configure the pagination of the retrieved product tags.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product types. Parameters used to filter and configure the pagination of the retrieved product types.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved products. Parameters used to filter and configure the pagination of the retrieved products.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminGetProductsVariantsParams # AdminGetProductsVariantsParams
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated. Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved regions. Parameters used to filter and configure the pagination of the retrieved regions.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The list of fulfillment options in a region. The list of fulfillment options in a region.
## constructor
The list of fulfillment options in a region.
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved reservations. Parameters used to filter and configure the pagination of the retrieved reservations.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated. Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved sales channels. Parameters used to filter and configure the pagination of the retrieved sales channels.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter the retrieved shipping options. Parameters used to filter the retrieved shipping options.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved stock locations. Parameters used to filter and configure the pagination of the retrieved stock locations.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated. Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved tax rates. Parameters used to filter and configure the pagination of the retrieved tax rates.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product variants. Parameters used to filter and configure the pagination of the retrieved product variants.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters used to filter retrieved customers. Filters used to filter retrieved customers.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on the retrieved orders. Filters to apply on the retrieved orders.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostAnalyticsConfigAnalyticsConfigReq # AdminPostAnalyticsConfigAnalyticsConfigReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostAnalyticsConfigReq # AdminPostAnalyticsConfigReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostAuthReq # AdminPostAuthReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostBatchesReq # AdminPostBatchesReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCollectionsCollectionReq # AdminPostCollectionsCollectionReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCollectionsReq # AdminPostCollectionsReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCurrenciesCurrencyReq # AdminPostCurrenciesCurrencyReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomerGroupsGroupCustomersBatchReq # AdminPostCustomerGroupsGroupCustomersBatchReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomerGroupsGroupReq # AdminPostCustomerGroupsGroupReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomerGroupsReq # AdminPostCustomerGroupsReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomersCustomerReq # AdminPostCustomersCustomerReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomersReq # AdminPostCustomersReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Fields to create or update a discount condition. Fields to create or update a discount condition.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Fields to create or update a discount condition. Fields to create or update a discount condition.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDiscountsDiscountConditionsConditionBatchReq # AdminPostDiscountsDiscountConditionsConditionBatchReq
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved. Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties ## Properties
<ParameterTypes parameters={[ <ParameterTypes parameters={[
Loaded 100 of 272 files, more files were not shown because too many files have changed in this diff. Show more