asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5516)

Browse Source 
Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx
View File

@@ -147,7 +147,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -155,7 +155,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -478,7 +478,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -486,7 +486,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",

8
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx
View File

@@ -150,7 +150,7 @@ async function createPriceSet () {
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -158,7 +158,7 @@ async function createPriceSet () {
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -485,7 +485,7 @@ async function createPriceSets () {
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -493,7 +493,7 @@ async function createPriceSets () {
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",

4
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx
View File

@@ -119,7 +119,7 @@ async function retrieveMoneyAmounts () {
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -127,7 +127,7 @@ async function retrieveMoneyAmounts () {
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",

290
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx Normal file
View File

@@ -0,0 +1,290 @@
---
displayed_sidebar: pricingReference
badge:
variant: orange
text: Beta
slug: /references/pricing/listAndCountPriceSetMoneyAmounts
sidebar_label: listAndCountPriceSetMoneyAmounts
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# listAndCountPriceSetMoneyAmounts - Pricing Module Reference
This documentation provides a reference to the `listAndCountPriceSetMoneyAmounts` method. This belongs to the Pricing Module.
This method is used to retrieve a paginated list of price set money amounts along with the total count of
available price set money amounts satisfying the provided filters.
## Example
To retrieve a list of price set money amounts using their IDs:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (id: string) {
const pricingService = await initializePricingModule()
const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
id: [id]
})
// do something with the price set money amounts or return them
}
```
To specify relations that should be retrieved within the price set money amounts:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (id: string) {
const pricingService = await initializePricingModule()
const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
id: [id]
}, {
relations: ["price_rules"],
})
// do something with the price set money amounts or return them
}
```
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: number) {
const pricingService = await initializePricingModule()
const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
id: [id]
}, {
relations: ["price_rules"],
skip,
take
})
// do something with the price set money amounts or return them
}
```
You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], skip: number, take: number) {
const pricingService = await initializePricingModule()
const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
$and: [
{
id: ids
},
{
title: titles
}
]
}, {
relations: ["price_rules"],
skip,
take
})
// do something with the price set money amounts or return them
}
```
## Parameters
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)",
"description": "The filters to apply on the retrieved price set money amounts.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "id",
"type": "`string`[]",
"description": "The IDs to filter the price set money amounts by.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "price_set_id",
"type": "`string`[]",
"description": "The IDs to filter the price set money amount's associated price set.",
"optional": true,
"defaultValue": "",
"children": []
}
]
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)\\>",
"description": "The configurations determining how the price set money amounts are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set money amount.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "order",
"type": "`object`",
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "relations",
"type": "`string`[]",
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "select",
"type": "(`string` \\| keyof `Entity`)[]",
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "skip",
"type": "`number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "take",
"type": "`number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "withDeleted",
"type": "`boolean`",
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"children": []
}
]
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "isolationLevel",
"type": "`string`",
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "manager",
"type": "`TManager`",
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "transactionManager",
"type": "`TManager`",
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"children": []
}
]
}
]} />
## Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[], `number`]\\>",
"optional": false,
"defaultValue": "",
"description": "The list of price set money amounts and their total count.",
"children": [
{
"name": "PriceSetMoneyAmountDTO[]",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
},
{
"name": "number",
"type": "`number`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />

330
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx Normal file
View File

@@ -0,0 +1,330 @@
---
displayed_sidebar: pricingReference
badge:
variant: orange
text: Beta
slug: /references/pricing/listPriceSetMoneyAmounts
sidebar_label: listPriceSetMoneyAmounts
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# listPriceSetMoneyAmounts - Pricing Module Reference
This documentation provides a reference to the `listPriceSetMoneyAmounts` method. This belongs to the Pricing Module.
This method is used to retrieve a paginated list of price set money amounts based on optional filters and configuration.
## Example
To retrieve a list of price set money amounts using their IDs:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (id: string) {
const pricingService = await initializePricingModule()
const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
id: [id]
})
// do something with the price set money amounts or return them
}
```
To specify relations that should be retrieved within the price set money amounts:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (id: string) {
const pricingService = await initializePricingModule()
const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
id: [id]
}, {
relations: ["price_rules"]
})
// do something with the price set money amounts or return them
}
```
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: number) {
const pricingService = await initializePricingModule()
const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
id: [id]
}, {
relations: ["price_rules"],
skip,
take
})
// do something with the price set money amounts or return them
}
```
You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], skip: number, take: number) {
const pricingService = await initializePricingModule()
const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
$and: [
{
id: ids
},
{
title: titles
}
]
}, {
relations: ["price_rules"],
skip,
take
})
// do something with the price set money amounts or return them
}
```
## Parameters
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)",
"description": "The filters to apply on the retrieved price set money amounts.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "id",
"type": "`string`[]",
"description": "The IDs to filter the price set money amounts by.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "price_set_id",
"type": "`string`[]",
"description": "The IDs to filter the price set money amount's associated price set.",
"optional": true,
"defaultValue": "",
"children": []
}
]
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)\\>",
"description": "The configurations determining how the price set money amounts are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set money amount.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "order",
"type": "`object`",
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "relations",
"type": "`string`[]",
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "select",
"type": "(`string` \\| keyof `Entity`)[]",
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "skip",
"type": "`number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "take",
"type": "`number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "withDeleted",
"type": "`boolean`",
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"children": []
}
]
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "isolationLevel",
"type": "`string`",
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "manager",
"type": "`TManager`",
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "transactionManager",
"type": "`TManager`",
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"children": []
}
]
}
]} />
## Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]\\>",
"optional": false,
"defaultValue": "",
"description": "The list of price set money amounts.",
"children": [
{
"name": "PriceSetMoneyAmountDTO[]",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "money_amount",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The title of the price set money amount.",
"optional": true,
"defaultValue": "",
"children": []
}
]
}
]
}
]} />

16
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx
View File

@@ -211,6 +211,14 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"defaultValue": "",
"children": []
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
@@ -219,6 +227,14 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"defaultValue": "",
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "title",
"type": "`string`",