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

docs: generate medusa-react reference (#6004)

Browse Source 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser
2024-01-05 17:03:38 +02:00
committed by GitHub
parent 6fc6a9de6a
commit 7d650771d1
2811 changed files with 231856 additions and 455063 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/inventory/interfaces/inventory.BulkUpdateInventoryLevelInput.mdx
+1 -38
View File
@@ -8,41 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The attributes to update in an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number`",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string`",
"description": "The ID of the associated inventory level.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number`",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The incoming quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The stocked quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.CreateInventoryItemInput.mdx
+1 -128
View File
@@ -8,131 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The details of the inventory item to be created.
<ParameterTypes parameters={[
{
"name": "description",
"type": "`null` \\| `string`",
"description": "The description of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "height",
"type": "`null` \\| `number`",
"description": "The height of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "hs_code",
"type": "`null` \\| `string`",
"description": "The HS code of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "length",
"type": "`null` \\| `number`",
"description": "The length of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "material",
"type": "`null` \\| `string`",
"description": "The material of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "mid_code",
"type": "`null` \\| `string`",
"description": "The MID code of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "origin_country",
"type": "`null` \\| `string`",
"description": "The origin country of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "Whether the inventory item requires shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sku",
"type": "`null` \\| `string`",
"description": "The SKU of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "The thumbnail of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`null` \\| `string`",
"description": "The title of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "weight",
"type": "`null` \\| `number`",
"description": "The weight of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "width",
"type": "`null` \\| `number`",
"description": "The width of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"description","type":"`null` \\| `string`","description":"The description of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS code of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID code of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the inventory item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The title of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.CreateInventoryLevelInput.mdx
+1 -47
View File
@@ -8,50 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The details of the inventory level to be created.
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number`",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string`",
"description": "The ID of the associated inventory item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reserved_quantity",
"type": "`number`",
"description": "The reserved quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number`",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The stocked quantity of the associated inventory item in the associated location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The incoming quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The reserved quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.CreateReservationItemInput.mdx
+1 -74
View File
@@ -8,77 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The details of the reservation item to be created.
<ParameterTypes parameters={[
{
"name": "created_by",
"type": "`string`",
"description": "The user or system that created the reservation. Can be any form of identification string.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The description of the reservation.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`string`",
"description": "An ID associated with an external third-party system that the reservation item is connected to.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string`",
"description": "The ID of the associated inventory item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "line_item_id",
"type": "`string`",
"description": "The ID of the associated line item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The reserved quantity.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The user or system that created the reservation. Can be any form of identification string.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the reservation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`string`","description":"An ID associated with an external third-party system that the reservation item is connected to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`","description":"The ID of the associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.FilterableInventoryItemProps.mdx
+1 -65
View File
@@ -8,68 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The filters to apply on retrieved inventory items.
<ParameterTypes parameters={[
{
"name": "hs_code",
"type": "`string` \\| `string`[] \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)",
"description": "The HS Codes to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string` \\| `string`[]",
"description": "The IDs to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string` \\| `string`[]",
"description": "Filter inventory items by the ID of their associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "origin_country",
"type": "`string` \\| `string`[]",
"description": "The origin country to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "q",
"type": "`string`",
"description": "Search term to search inventory items' attributes.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "Filter inventory items by whether they require shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sku",
"type": "`string` \\| `string`[] \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)",
"description": "The SKUs to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"hs_code","type":"`string` \\| `string`[] \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)","description":"The HS Codes to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"Filter inventory items by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `string`[]","description":"The origin country to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search inventory items' attributes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Filter inventory items by whether they require shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[] \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)","description":"The SKUs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.FilterableInventoryLevelProps.mdx
+1 -47
View File
@@ -8,50 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The filters to apply on retrieved inventory levels.
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)",
"description": "Filters to apply on inventory levels' `incoming_quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string` \\| `string`[]",
"description": "Filter inventory levels by the ID of their associated inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string` \\| `string`[]",
"description": "Filter inventory levels by the ID of their associated inventory location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reserved_quantity",
"type": "`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)",
"description": "Filters to apply on inventory levels' `reserved_quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)",
"description": "Filters to apply on inventory levels' `stocked_quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"incoming_quantity","type":"`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)","description":"Filters to apply on inventory levels' `incoming_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string` \\| `string`[]","description":"Filter inventory levels by the ID of their associated inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"Filter inventory levels by the ID of their associated inventory location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)","description":"Filters to apply on inventory levels' `reserved_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)","description":"Filters to apply on inventory levels' `stocked_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.FilterableReservationItemProps.mdx
+1 -65
View File
@@ -8,68 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The filters to apply on retrieved reservation items.
<ParameterTypes parameters={[
{
"name": "created_by",
"type": "`string` \\| `string`[]",
"description": "The \"created by\" values to filter reservation items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string` \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)",
"description": "Description filters to apply on the reservation items' `description` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string` \\| `string`[]",
"description": "The IDs to filter reservation items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string` \\| `string`[]",
"description": "Filter reservation items by the ID of their associated inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "line_item_id",
"type": "`string` \\| `string`[]",
"description": "Filter reservation items by the ID of their associated line item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string` \\| `string`[]",
"description": "Filter reservation items by the ID of their associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)",
"description": "Filters to apply on the reservation items' `quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"created_by","type":"`string` \\| `string`[]","description":"The \"created by\" values to filter reservation items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)","description":"Description filters to apply on the reservation items' `description` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter reservation items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string` \\| `string`[]","description":"Filter reservation items by the ID of their associated inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `string`[]","description":"Filter reservation items by the ID of their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"Filter reservation items by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| [NumericalComparisonOperator](inventory.NumericalComparisonOperator.mdx)","description":"Filters to apply on the reservation items' `quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.FindConfig.mdx
+2 -67
View File
@@ -11,71 +11,6 @@ which provides correct typing of field names in its properties.
## Type parameters
<ParameterTypes parameters={[
{
"name": "Entity",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Entity","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
<ParameterTypes parameters={[
{
"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`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"expandable": false,
"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": "",
"expandable": false,
"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": "",
"expandable": false,
"children": []
},
{
"name": "skip",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "take",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"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\n`SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"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`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"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\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.IInventoryService.mdx
+28 -28
View File
@@ -11,31 +11,31 @@ This section of the documentation provides a reference to the `IInventoryService
## Methods
- [adjustInventory](../../IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx)
- [confirmInventory](../../IInventoryService/methods/inventory.IInventoryService.confirmInventory.mdx)
- [createInventoryItem](../../IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx)
- [createInventoryItems](../../IInventoryService/methods/inventory.IInventoryService.createInventoryItems.mdx)
- [createInventoryLevel](../../IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx)
- [createInventoryLevels](../../IInventoryService/methods/inventory.IInventoryService.createInventoryLevels.mdx)
- [createReservationItem](../../IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx)
- [createReservationItems](../../IInventoryService/methods/inventory.IInventoryService.createReservationItems.mdx)
- [deleteInventoryItem](../../IInventoryService/methods/inventory.IInventoryService.deleteInventoryItem.mdx)
- [deleteInventoryItemLevelByLocationId](../../IInventoryService/methods/inventory.IInventoryService.deleteInventoryItemLevelByLocationId.mdx)
- [deleteInventoryLevel](../../IInventoryService/methods/inventory.IInventoryService.deleteInventoryLevel.mdx)
- [deleteReservationItem](../../IInventoryService/methods/inventory.IInventoryService.deleteReservationItem.mdx)
- [deleteReservationItemByLocationId](../../IInventoryService/methods/inventory.IInventoryService.deleteReservationItemByLocationId.mdx)
- [deleteReservationItemsByLineItem](../../IInventoryService/methods/inventory.IInventoryService.deleteReservationItemsByLineItem.mdx)
- [listInventoryItems](../../IInventoryService/methods/inventory.IInventoryService.listInventoryItems.mdx)
- [listInventoryLevels](../../IInventoryService/methods/inventory.IInventoryService.listInventoryLevels.mdx)
- [listReservationItems](../../IInventoryService/methods/inventory.IInventoryService.listReservationItems.mdx)
- [restoreInventoryItem](../../IInventoryService/methods/inventory.IInventoryService.restoreInventoryItem.mdx)
- [retrieveAvailableQuantity](../../IInventoryService/methods/inventory.IInventoryService.retrieveAvailableQuantity.mdx)
- [retrieveInventoryItem](../../IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx)
- [retrieveInventoryLevel](../../IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx)
- [retrieveReservationItem](../../IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx)
- [retrieveReservedQuantity](../../IInventoryService/methods/inventory.IInventoryService.retrieveReservedQuantity.mdx)
- [retrieveStockedQuantity](../../IInventoryService/methods/inventory.IInventoryService.retrieveStockedQuantity.mdx)
- [updateInventoryItem](../../IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx)
- [updateInventoryLevel](../../IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx)
- [updateInventoryLevels](../../IInventoryService/methods/inventory.IInventoryService.updateInventoryLevels.mdx)
- [updateReservationItem](../../IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx)
- [adjustInventory](../IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx)
- [confirmInventory](../IInventoryService/methods/inventory.IInventoryService.confirmInventory.mdx)
- [createInventoryItem](../IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx)
- [createInventoryItems](../IInventoryService/methods/inventory.IInventoryService.createInventoryItems.mdx)
- [createInventoryLevel](../IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx)
- [createInventoryLevels](../IInventoryService/methods/inventory.IInventoryService.createInventoryLevels.mdx)
- [createReservationItem](../IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx)
- [createReservationItems](../IInventoryService/methods/inventory.IInventoryService.createReservationItems.mdx)
- [deleteInventoryItem](../IInventoryService/methods/inventory.IInventoryService.deleteInventoryItem.mdx)
- [deleteInventoryItemLevelByLocationId](../IInventoryService/methods/inventory.IInventoryService.deleteInventoryItemLevelByLocationId.mdx)
- [deleteInventoryLevel](../IInventoryService/methods/inventory.IInventoryService.deleteInventoryLevel.mdx)
- [deleteReservationItem](../IInventoryService/methods/inventory.IInventoryService.deleteReservationItem.mdx)
- [deleteReservationItemByLocationId](../IInventoryService/methods/inventory.IInventoryService.deleteReservationItemByLocationId.mdx)
- [deleteReservationItemsByLineItem](../IInventoryService/methods/inventory.IInventoryService.deleteReservationItemsByLineItem.mdx)
- [listInventoryItems](../IInventoryService/methods/inventory.IInventoryService.listInventoryItems.mdx)
- [listInventoryLevels](../IInventoryService/methods/inventory.IInventoryService.listInventoryLevels.mdx)
- [listReservationItems](../IInventoryService/methods/inventory.IInventoryService.listReservationItems.mdx)
- [restoreInventoryItem](../IInventoryService/methods/inventory.IInventoryService.restoreInventoryItem.mdx)
- [retrieveAvailableQuantity](../IInventoryService/methods/inventory.IInventoryService.retrieveAvailableQuantity.mdx)
- [retrieveInventoryItem](../IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx)
- [retrieveInventoryLevel](../IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx)
- [retrieveReservationItem](../IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx)
- [retrieveReservedQuantity](../IInventoryService/methods/inventory.IInventoryService.retrieveReservedQuantity.mdx)
- [retrieveStockedQuantity](../IInventoryService/methods/inventory.IInventoryService.retrieveStockedQuantity.mdx)
- [updateInventoryItem](../IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx)
- [updateInventoryLevel](../IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx)
- [updateInventoryLevels](../IInventoryService/methods/inventory.IInventoryService.updateInventoryLevels.mdx)
- [updateReservationItem](../IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx)
www/apps/docs/content/references/inventory/interfaces/inventory.JoinerServiceConfig.mdx
+1 -230
View File
@@ -6,233 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerServiceConfig
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[JoinerServiceConfigAlias](inventory.JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](inventory.JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "args",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "extends",
"type": "`object`[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "relationship",
"type": "[JoinerRelationship](../types/inventory.JoinerRelationship.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "alias",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "args",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "foreignKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inverse",
"type": "`boolean`",
"description": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isInternalService",
"type": "`boolean`",
"description": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isList",
"type": "`boolean`",
"description": "Force the relationship to return a list",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "primaryKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "fieldAlias",
"type": "`Record<string, string \\| object>`",
"description": "alias for deeper nested relationships (e.g. &#123; 'price': 'prices.calculated\\_price\\_set.amount' &#125;)",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "primaryKeys",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "relationships",
"type": "[JoinerRelationship](../types/inventory.JoinerRelationship.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "alias",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "args",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "foreignKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inverse",
"type": "`boolean`",
"description": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isInternalService",
"type": "`boolean`",
"description": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isList",
"type": "`boolean`",
"description": "Force the relationship to return a list",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "primaryKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"[JoinerServiceConfigAlias](inventory.JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](inventory.JoinerServiceConfigAlias.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"relationship","type":"[JoinerRelationship](../types/inventory.JoinerRelationship.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. &#123; 'price': 'prices.calculated\\_price\\_set.amount' &#125;)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[JoinerRelationship](../types/inventory.JoinerRelationship.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.JoinerServiceConfigAlias.mdx
+1 -20
View File
@@ -6,23 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerServiceConfigAlias
<ParameterTypes parameters={[
{
"name": "args",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.NumericalComparisonOperator.mdx
+1 -38
View File
@@ -6,41 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# NumericalComparisonOperator
<ParameterTypes parameters={[
{
"name": "gt",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gte",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lt",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lte",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"gt","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.SharedContext.mdx
+1 -20
View File
@@ -8,23 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A shared context object that is used to share resources between the application and the module.
<ParameterTypes parameters={[
{
"name": "manager",
"type": "`EntityManager`",
"description": "An instance of an entity manager.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "An instance of a transaction manager.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"manager","type":"`EntityManager`","description":"An instance of an entity manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager","type":"`EntityManager`","description":"An instance of a transaction manager.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.StringComparisonOperator.mdx
+1 -65
View File
@@ -6,68 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# StringComparisonOperator
<ParameterTypes parameters={[
{
"name": "contains",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ends_with",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gt",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gte",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lt",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lte",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "starts_with",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"contains","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.UpdateInventoryLevelInput.mdx
+1 -20
View File
@@ -8,23 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The attributes to update in an inventory level.
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number`",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number`",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"incoming_quantity","type":"`number`","description":"The incoming quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The stocked quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/inventory/interfaces/inventory.UpdateReservationItemInput.mdx
+1 -38
View File
@@ -8,41 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The attributes to update in a reservation item.
<ParameterTypes parameters={[
{
"name": "description",
"type": "`string`",
"description": "The description of the reservation item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The reserved quantity.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"description","type":"`string`","description":"The description of the reservation item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The reserved quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />