chore(docs): Generated References (automated) (#10276)
Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `dml` - `fulfillment` - `helper_steps` - `inventory_next` - `js_sdk` - `medusa` - `medusa_config` - `modules` - `modules_sdk` - `order` - `payment` - `payment_provider` - `pricing` - `product` - `product_models` - `promotion` - `region` - `sales_channel` - `search` - `stock_location_next` - `store` - `tax` - `tax_provider` - `types` - `user` - `utils` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
67e2e718e9
commit
d5ee0070b4
928 files changed
+182409
-172163
No files matched your search
+1
-1
@@ -61,7 +61,7 @@ const [inventoryItems, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryItemProps](../../../interfaces/inventory_next.FilterableInventoryItemProps/page.mdx)","description":"The filters to apply on the retrieved inventory items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search inventory items' attributes.","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":"sku","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The SKUs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"hs_code","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The HS Codes to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryItemDTO](../../../interfaces/inventory_next.InventoryItemDTO/page.mdx)>","description":"The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory item.","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,"defaultValuLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryItemProps](../../../interfaces/inventory_next.FilterableInventoryItemProps/page.mdx)","description":"The filters to apply on the retrieved inventory items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search inventory items' attributes.","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":"sku","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The SKUs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"hs_code","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The HS Codes to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryItemDTO](../../../interfaces/inventory_next.InventoryItemDTO/page.mdx)>","description":"The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory item.","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,"defaultValuLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const [inventoryLevels, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx)","description":"The filters to apply on the retrieved inventory levels.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter inventory levels by the ID","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":"stocked_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `stocked_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `reserved_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `incoming_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$oLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx)","description":"The filters to apply on the retrieved inventory levels.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter inventory levels by the ID","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":"stocked_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `stocked_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `reserved_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `incoming_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$oLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const [reservationItems, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableReservationItemProps](../../../interfaces/inventory_next.FilterableReservationItemProps/page.mdx)","description":"The filters to apply on the retrieved reservation items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter reservation items by.","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":"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":"location_id","type":"`string` \\| `string`[]","description":"Filter reservation items by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"Description filters to apply on the reservation items' `description` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_by","type":"`string` \\| `string`[]","description":"The \"created by\" values to filter reservation items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| [NumericalComparisonOperator](../../../interfaces/inventory_next.NumericalComparisonOperator/page.mdx)","description":"Filters to apply on the reservation items' `quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`number`","description":"The filtered number must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`number`","description":"The filtered number must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`number`","description":"The filtered number must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`number`","description":"The filtered number must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[ReservationItemDTO](../../../interfaces/inventory_next.ReservationItemDTO/page.mdx)>","description":"The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a reservation item.","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":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in Line truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableReservationItemProps](../../../interfaces/inventory_next.FilterableReservationItemProps/page.mdx)","description":"The filters to apply on the retrieved reservation items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter reservation items by.","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":"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":"location_id","type":"`string` \\| `string`[]","description":"Filter reservation items by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"Description filters to apply on the reservation items' `description` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_by","type":"`string` \\| `string`[]","description":"The \"created by\" values to filter reservation items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| [NumericalComparisonOperator](../../../interfaces/inventory_next.NumericalComparisonOperator/page.mdx)","description":"Filters to apply on the reservation items' `quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`number`","description":"The filtered number must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`number`","description":"The filtered number must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`number`","description":"The filtered number must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`number`","description":"The filtered number must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[ReservationItemDTO](../../../interfaces/inventory_next.ReservationItemDTO/page.mdx)>","description":"The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a reservation item.","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":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const inventoryItems = await inventoryModuleService.listInventoryItems(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryItemProps](../../../interfaces/inventory_next.FilterableInventoryItemProps/page.mdx)","description":"The filters to apply on the retrieved inventory items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search inventory items' attributes.","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":"sku","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The SKUs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"hs_code","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The HS Codes to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryItemDTO](../../../interfaces/inventory_next.InventoryItemDTO/page.mdx)>","description":"The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory item.","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,"defaultValuLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryItemProps](../../../interfaces/inventory_next.FilterableInventoryItemProps/page.mdx)","description":"The filters to apply on the retrieved inventory items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search inventory items' attributes.","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":"sku","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The SKUs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"hs_code","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"The HS Codes to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","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":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryItemDTO](../../../interfaces/inventory_next.InventoryItemDTO/page.mdx)>","description":"The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory item.","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,"defaultValuLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const inventoryLevels =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx)","description":"The filters to apply on the retrieved inventory levels.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter inventory levels by the ID","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":"stocked_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `stocked_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `reserved_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `incoming_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$oLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx)","description":"The filters to apply on the retrieved inventory levels.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter inventory levels by the ID","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":"stocked_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `stocked_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `reserved_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number` \\| [OperatorMap](../../../types/inventory_next.OperatorMap/page.mdx)<Number>","description":"Filters to apply on inventory levels' `incoming_quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<T> \\| T)[]","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":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[{"name":"$and","type":"([FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/inventory_next.BaseFilterable/page.mdx)<[FilterableInventoryLevelProps](../../../interfaces/inventory_next.FilterableInventoryLevelProps/page.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":"","expandable":false,"children":[]},{"name":"$oLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const reservationItems =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableReservationItemProps](../../../interfaces/inventory_next.FilterableReservationItemProps/page.mdx)","description":"The filters to apply on the retrieved reservation items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter reservation items by.","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":"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":"location_id","type":"`string` \\| `string`[]","description":"Filter reservation items by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"Description filters to apply on the reservation items' `description` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_by","type":"`string` \\| `string`[]","description":"The \"created by\" values to filter reservation items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| [NumericalComparisonOperator](../../../interfaces/inventory_next.NumericalComparisonOperator/page.mdx)","description":"Filters to apply on the reservation items' `quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`number`","description":"The filtered number must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`number`","description":"The filtered number must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`number`","description":"The filtered number must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`number`","description":"The filtered number must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[ReservationItemDTO](../../../interfaces/inventory_next.ReservationItemDTO/page.mdx)>","description":"The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a reservation item.","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":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in Line truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableReservationItemProps](../../../interfaces/inventory_next.FilterableReservationItemProps/page.mdx)","description":"The filters to apply on the retrieved reservation items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter reservation items by.","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":"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":"location_id","type":"`string` \\| `string`[]","description":"Filter reservation items by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [StringComparisonOperator](../../../interfaces/inventory_next.StringComparisonOperator/page.mdx)","description":"Description filters to apply on the reservation items' `description` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`string`","description":"The filtered string must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`string`","description":"The filtered string must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`string`","description":"The filtered string must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`string`","description":"The filtered string must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"contains","type":"`string`","description":"The filtered string must contain this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_with","type":"`string`","description":"The filtered string must start with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_with","type":"`string`","description":"The filtered string must end with this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_by","type":"`string` \\| `string`[]","description":"The \"created by\" values to filter reservation items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| [NumericalComparisonOperator](../../../interfaces/inventory_next.NumericalComparisonOperator/page.mdx)","description":"Filters to apply on the reservation items' `quantity` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`number`","description":"The filtered number must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`number`","description":"The filtered number must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`number`","description":"The filtered number must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`number`","description":"The filtered number must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[ReservationItemDTO](../../../interfaces/inventory_next.ReservationItemDTO/page.mdx)>","description":"The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a reservation item.","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":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -40,7 +40,7 @@ const inventoryItem = await inventoryModuleService.retrieveInventoryItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"inventoryItemId","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryItemDTO](../../../interfaces/inventory_next.InventoryItemDTO/page.mdx)>","description":"The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory item.","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":"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":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & 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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/inventory_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/inventory_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","desLine truncated
|
||||
<TypeList types={[{"name":"inventoryItemId","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryItemDTO](../../../interfaces/inventory_next.InventoryItemDTO/page.mdx)>","description":"The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory item.","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":"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":"order","type":"[FindConfigOrder](../../../types/inventory_next.FindConfigOrder/page.mdx)","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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/inventory_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/inventory_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -43,7 +43,7 @@ const inventoryLevel =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"inventoryLevelId","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryLevelDTO](../../../interfaces/inventory_next.InventoryLevelDTO/page.mdx)>","description":"The configurations determining how the inventory level is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory level.","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":"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":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & 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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/inventory_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/inventory_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`Line truncated
|
||||
<TypeList types={[{"name":"inventoryLevelId","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[InventoryLevelDTO](../../../interfaces/inventory_next.InventoryLevelDTO/page.mdx)>","description":"The configurations determining how the inventory level is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a inventory level.","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":"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":"order","type":"[FindConfigOrder](../../../types/inventory_next.FindConfigOrder/page.mdx)","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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/inventory_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/inventory_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -43,7 +43,7 @@ const reservationItem =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"reservationId","type":"`string`","description":"The reservation's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[ReservationItemDTO](../../../interfaces/inventory_next.ReservationItemDTO/page.mdx)>","description":"The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a reservation item.","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":"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":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & 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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/inventory_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/inventory_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","Line truncated
|
||||
<TypeList types={[{"name":"reservationId","type":"`string`","description":"The reservation's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/inventory_next.FindConfig/page.mdx)<[ReservationItemDTO](../../../interfaces/inventory_next.ReservationItemDTO/page.mdx)>","description":"The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a reservation item.","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":"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":"order","type":"[FindConfigOrder](../../../types/inventory_next.FindConfigOrder/page.mdx)","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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/inventory_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"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":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/inventory_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","typLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -13,4 +13,4 @@ which provides correct typing of field names in its properties.
|
||||
|
||||
<TypeList types={[{"name":"Entity","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
|
||||
<TypeList types={[{"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":"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":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & 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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
<TypeList types={[{"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":"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":"order","type":"[FindConfigOrder](../../types/inventory_next.FindConfigOrder/page.mdx)","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":"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":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
+9
-7
@@ -6,15 +6,17 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# IBigNumber
|
||||
|
||||
## Properties
|
||||
|
||||
- [numeric](page.mdx#numeric)
|
||||
- [raw](page.mdx#raw)
|
||||
- [bigNumber](page.mdx#bignumber)
|
||||
|
||||
## Methods
|
||||
|
||||
- [toJSON](../../IBigNumber/methods/inventory_next.IBigNumber.toJSON/page.mdx)
|
||||
- [valueOf](../../IBigNumber/methods/inventory_next.IBigNumber.valueOf/page.mdx)
|
||||
|
||||
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/inventory_next.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
|
||||
## Properties
|
||||
|
||||
- [bigNumber](page.mdx#bignumber)
|
||||
- [numeric](page.mdx#numeric)
|
||||
- [raw](page.mdx#raw)
|
||||
|
||||
___
|
||||
|
||||
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/inventory_next.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
|
||||
+31
-31
@@ -19,38 +19,38 @@ The main service interface for the Inventory Module.
|
||||
|
||||
## Methods
|
||||
|
||||
- [listInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.listInventoryItems/page.mdx)
|
||||
- [listAndCountInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.listAndCountInventoryItems/page.mdx)
|
||||
- [listReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.listReservationItems/page.mdx)
|
||||
- [listAndCountReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.listAndCountReservationItems/page.mdx)
|
||||
- [listInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.listInventoryLevels/page.mdx)
|
||||
- [listAndCountInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.listAndCountInventoryLevels/page.mdx)
|
||||
- [retrieveInventoryItem](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveInventoryItem/page.mdx)
|
||||
- [retrieveInventoryLevelByItemAndLocation](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveInventoryLevelByItemAndLocation/page.mdx)
|
||||
- [retrieveInventoryLevel](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveInventoryLevel/page.mdx)
|
||||
- [retrieveReservationItem](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveReservationItem/page.mdx)
|
||||
- [createReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.createReservationItems/page.mdx)
|
||||
- [createInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.createInventoryItems/page.mdx)
|
||||
- [createInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.createInventoryLevels/page.mdx)
|
||||
- [updateInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.updateInventoryLevels/page.mdx)
|
||||
- [updateInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.updateInventoryItems/page.mdx)
|
||||
- [updateReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.updateReservationItems/page.mdx)
|
||||
- [deleteReservationItemsByLineItem](../../IInventoryService/methods/inventory_next.IInventoryService.deleteReservationItemsByLineItem/page.mdx)
|
||||
- [restoreReservationItemsByLineItem](../../IInventoryService/methods/inventory_next.IInventoryService.restoreReservationItemsByLineItem/page.mdx)
|
||||
- [deleteReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.deleteReservationItems/page.mdx)
|
||||
- [softDeleteReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.softDeleteReservationItems/page.mdx)
|
||||
- [restoreReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.restoreReservationItems/page.mdx)
|
||||
- [deleteInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryItems/page.mdx)
|
||||
- [softDeleteInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.softDeleteInventoryItems/page.mdx)
|
||||
- [restoreInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.restoreInventoryItems/page.mdx)
|
||||
- [deleteInventoryItemLevelByLocationId](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryItemLevelByLocationId/page.mdx)
|
||||
- [deleteReservationItemByLocationId](../../IInventoryService/methods/inventory_next.IInventoryService.deleteReservationItemByLocationId/page.mdx)
|
||||
- [deleteInventoryLevel](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryLevel/page.mdx)
|
||||
- [deleteInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryLevels/page.mdx)
|
||||
- [softDeleteInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.softDeleteInventoryLevels/page.mdx)
|
||||
- [restoreInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.restoreInventoryLevels/page.mdx)
|
||||
- [adjustInventory](../../IInventoryService/methods/inventory_next.IInventoryService.adjustInventory/page.mdx)
|
||||
- [confirmInventory](../../IInventoryService/methods/inventory_next.IInventoryService.confirmInventory/page.mdx)
|
||||
- [createInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.createInventoryItems/page.mdx)
|
||||
- [createInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.createInventoryLevels/page.mdx)
|
||||
- [createReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.createReservationItems/page.mdx)
|
||||
- [deleteInventoryItemLevelByLocationId](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryItemLevelByLocationId/page.mdx)
|
||||
- [deleteInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryItems/page.mdx)
|
||||
- [deleteInventoryLevel](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryLevel/page.mdx)
|
||||
- [deleteInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.deleteInventoryLevels/page.mdx)
|
||||
- [deleteReservationItemByLocationId](../../IInventoryService/methods/inventory_next.IInventoryService.deleteReservationItemByLocationId/page.mdx)
|
||||
- [deleteReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.deleteReservationItems/page.mdx)
|
||||
- [deleteReservationItemsByLineItem](../../IInventoryService/methods/inventory_next.IInventoryService.deleteReservationItemsByLineItem/page.mdx)
|
||||
- [listAndCountInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.listAndCountInventoryItems/page.mdx)
|
||||
- [listAndCountInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.listAndCountInventoryLevels/page.mdx)
|
||||
- [listAndCountReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.listAndCountReservationItems/page.mdx)
|
||||
- [listInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.listInventoryItems/page.mdx)
|
||||
- [listInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.listInventoryLevels/page.mdx)
|
||||
- [listReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.listReservationItems/page.mdx)
|
||||
- [restoreInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.restoreInventoryItems/page.mdx)
|
||||
- [restoreInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.restoreInventoryLevels/page.mdx)
|
||||
- [restoreReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.restoreReservationItems/page.mdx)
|
||||
- [restoreReservationItemsByLineItem](../../IInventoryService/methods/inventory_next.IInventoryService.restoreReservationItemsByLineItem/page.mdx)
|
||||
- [retrieveAvailableQuantity](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveAvailableQuantity/page.mdx)
|
||||
- [retrieveStockedQuantity](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveStockedQuantity/page.mdx)
|
||||
- [retrieveInventoryItem](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveInventoryItem/page.mdx)
|
||||
- [retrieveInventoryLevel](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveInventoryLevel/page.mdx)
|
||||
- [retrieveInventoryLevelByItemAndLocation](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveInventoryLevelByItemAndLocation/page.mdx)
|
||||
- [retrieveReservationItem](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveReservationItem/page.mdx)
|
||||
- [retrieveReservedQuantity](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveReservedQuantity/page.mdx)
|
||||
- [retrieveStockedQuantity](../../IInventoryService/methods/inventory_next.IInventoryService.retrieveStockedQuantity/page.mdx)
|
||||
- [softDeleteInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.softDeleteInventoryItems/page.mdx)
|
||||
- [softDeleteInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.softDeleteInventoryLevels/page.mdx)
|
||||
- [softDeleteReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.softDeleteReservationItems/page.mdx)
|
||||
- [updateInventoryItems](../../IInventoryService/methods/inventory_next.IInventoryService.updateInventoryItems/page.mdx)
|
||||
- [updateInventoryLevels](../../IInventoryService/methods/inventory_next.IInventoryService.updateInventoryLevels/page.mdx)
|
||||
- [updateReservationItems](../../IInventoryService/methods/inventory_next.IInventoryService.updateReservationItems/page.mdx)
|
||||
+2
-2
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Methods
|
||||
|
||||
- [save](../../IMessageAggregator/methods/inventory_next.IMessageAggregator.save/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/inventory_next.IMessageAggregator.getMessages/page.mdx)
|
||||
- [clearMessages](../../IMessageAggregator/methods/inventory_next.IMessageAggregator.clearMessages/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/inventory_next.IMessageAggregator.getMessages/page.mdx)
|
||||
- [save](../../IMessageAggregator/methods/inventory_next.IMessageAggregator.save/page.mdx)
|
||||
- [saveRawMessageData](../../IMessageAggregator/methods/inventory_next.IMessageAggregator.saveRawMessageData/page.mdx)
|
||||
+6
-4
@@ -6,12 +6,14 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# IModuleService
|
||||
|
||||
## Properties
|
||||
|
||||
- [\_\_hooks](page.mdx#__hooks)
|
||||
|
||||
## Methods
|
||||
|
||||
- [\_\_joinerConfig](../../IModuleService/methods/inventory_next.IModuleService.__joinerConfig/page.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
- [\_\_hooks](page.mdx#__hooks)
|
||||
|
||||
___
|
||||
|
||||
<TypeList types={[{"name":"__hooks","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IModuleService"/>
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
---
|
||||
displayed_sidebar: inventoryNextReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# FindConfigOrder
|
||||
|
||||
**FindConfigOrder**: `object`
|
||||
|
||||
Temporary type fixing to allow any level of orders until we get to properly clean all the types
|
||||
Reference in new issue
Block a user