chore(docs): Generated References (#6351)
Generated the following references: - `file` - `fulfillment` - `inventory` - `js_client` - `medusa` - `medusa_config` - `medusa_react` - `modules` - `notification` - `payment` - `price_selection` - `pricing` - `product` - `services` - `stock_location` - `tax` - `tax_calculation` - `types` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
e56c440911
commit
1d0a978ffe
343 files changed
+92337
-73600
No files matched your search
+1
-1
@@ -15,7 +15,7 @@ This method is used to adjust the inventory level's stocked quantity. The invent
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to confirm whether the specified quantity of an inventory it
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to create an inventory item.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to create inventory items.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to create inventory level.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to create inventory levels.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to create a reservation item.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to create reservation items.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@ This method is used to delete an inventory item or multiple inventory items. The
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method deletes the inventory item level(s) for the ID(s) of associated loca
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to delete an inventory level. The inventory level is identif
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to delete a reservation item or multiple reservation items b
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method deletes reservation item(s) by the ID(s) of associated location(s).
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to delete the reservation items associated with a line item
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+3
-3
@@ -17,7 +17,7 @@ This method is used to retrieve a paginated list of inventory items along with t
|
||||
To retrieve a list of inventory items using their IDs:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -35,7 +35,7 @@ async function retrieveInventoryItems (ids: string[]) {
|
||||
To specify relations that should be retrieved within the inventory items:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -55,7 +55,7 @@ async function retrieveInventoryItems (ids: string[]) {
|
||||
By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+3
-3
@@ -17,7 +17,7 @@ This method is used to retrieve a paginated list of inventory levels along with
|
||||
To retrieve a list of inventory levels using their IDs:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -35,7 +35,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[]) {
|
||||
To specify relations that should be retrieved within the inventory levels:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -55,7 +55,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[]) {
|
||||
By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+3
-3
@@ -17,7 +17,7 @@ This method is used to retrieve a paginated list of reservation items along with
|
||||
To retrieve a list of reservation items using their IDs:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -35,7 +35,7 @@ async function retrieveReservationItems (ids: string[]) {
|
||||
To specify relations that should be retrieved within the reservation items:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -55,7 +55,7 @@ async function retrieveReservationItems (ids: string[]) {
|
||||
By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to restore an inventory item or multiple inventory items tha
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+2
-2
@@ -15,7 +15,7 @@ This method is used to retrieve the available quantity of an inventory item with
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -29,7 +29,7 @@ async function retrieveAvailableQuantity (
|
||||
inventoryItemId,
|
||||
locationIds,
|
||||
)
|
||||
|
||||
|
||||
// do something with the quantity or return it
|
||||
}
|
||||
```
|
||||
|
||||
+2
-2
@@ -17,7 +17,7 @@ This method is used to retrieve an inventory item by its ID
|
||||
A simple example that retrieves a inventory item by its ID:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -33,7 +33,7 @@ async function retrieveInventoryItem (id: string) {
|
||||
To specify relations that should be retrieved:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+2
-2
@@ -15,12 +15,12 @@ This method is used to retrieve an inventory level for an inventory item and a l
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
async function retrieveInventoryLevel (
|
||||
inventoryItemId: string,
|
||||
inventoryItemId: string,
|
||||
locationId: string
|
||||
) {
|
||||
const inventoryModule = await initializeInventoryModule({})
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to retrieve a reservation item by its ID.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+2
-2
@@ -15,7 +15,7 @@ This method is used to retrieve the reserved quantity of an inventory item withi
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -29,7 +29,7 @@ async function retrieveReservedQuantity (
|
||||
inventoryItemId,
|
||||
locationIds,
|
||||
)
|
||||
|
||||
|
||||
// do something with the quantity or return it
|
||||
}
|
||||
```
|
||||
|
||||
+2
-2
@@ -15,7 +15,7 @@ This method is used to retrieve the stocked quantity of an inventory item within
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
@@ -29,7 +29,7 @@ async function retrieveStockedQuantity (
|
||||
inventoryItemId,
|
||||
locationIds,
|
||||
)
|
||||
|
||||
|
||||
// do something with the quantity or return it
|
||||
}
|
||||
```
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to update an inventory item.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to update an inventory level. The inventory level is identif
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to update inventory levels. Each inventory level is identifi
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This method is used to update a reservation item.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializeInventoryModule,
|
||||
} from "@medusajs/inventory"
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: inventoryReference
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# IModuleService
|
||||
@@ -6,6 +6,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SharedContext
|
||||
|
||||
## Deprecated
|
||||
|
||||
use `Context` instead
|
||||
|
||||
A context used to share resources, such as transaction manager, between the application and the module.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"An instance of a transaction manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"`EntityManager`","description":"An instance of an entity manager.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="SharedContext"/>
|
||||
Reference in new issue
Block a user