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

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/interfaces/AddPriceListPricesDTO.mdx
+32
View File
@@ -0,0 +1,32 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# AddPriceListPricesDTO
The prices to be added to a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "The ID of the price list to add prices to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "prices",
"type": "[PriceListPriceDTO](PriceListPriceDTO.mdx)[]",
"description": "The prices to add.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/AddRulesDTO.mdx
+2 -2
View File
@@ -22,8 +22,8 @@ The rules to add to a price set.
},
{
"name": "rules",
"type": "`&#123; attribute: string &#125;`[]",
"description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"type": "``{ attribute: string }``[]",
"description": "The rules to add to a price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/Buffer.mdx
+7 -7
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"Uint8Array\"``",
"type": "`\"Uint8Array\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ ___
### compare
`**compare**(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): `0` \| `1` \| `-1``
`**compare**(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): 0 \| 1 \| -1`
Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order.
Comparison is based on the actual sequence of bytes in each `Buffer`.
@@ -230,12 +230,12 @@ console.log(buf1.compare(buf2, 5, 6, 5));
#### Returns
``0`` \| ``1`` \| ``-1``
`0` \| `1` \| `-1`
<ParameterTypes parameters={[
{
"name": "`0` \\| `1` \\| `-1`",
"type": "``0`` \\| ``1`` \\| ``-1``",
"name": "0 \\| 1 \\| -1",
"type": "`0` \\| `1` \\| `-1`",
"optional": true,
"defaultValue": "",
"description": "",
@@ -3852,7 +3852,7 @@ ___
### toJSON
`**toJSON**(): &#123; data: number[] ; type: `"Buffer"` &#125;`
`**toJSON**(): &#123; data: number[] ; type: "Buffer" &#125;`
Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/JSON/stringify) implicitly calls
this function when stringifying a `Buffer` instance.
@@ -3907,7 +3907,7 @@ console.log(copy);
},
{
"name": "type",
"type": "``\"Buffer\"``",
"type": "`\"Buffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/BufferConstructor.mdx
+5 -5
View File
@@ -500,7 +500,7 @@ ___
### compare
`**compare**(buf1, buf2): `0` \| `1` \| `-1``
`**compare**(buf1, buf2): 0 \| 1 \| -1`
Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`.
@@ -541,12 +541,12 @@ console.log(arr.sort(Buffer.compare));
#### Returns
``0`` \| ``1`` \| ``-1``
`0` \| `1` \| `-1`
<ParameterTypes parameters={[
{
"name": "`0` \\| `1` \\| `-1`",
"type": "``0`` \\| ``1`` \\| ``-1``",
"name": "0 \\| 1 \\| -1",
"type": "`0` \\| `1` \\| `-1`",
"optional": true,
"defaultValue": "",
"description": "Either `-1`, `0`, or `1`, depending on the result of the comparison. See `compare` for details.",
@@ -865,7 +865,7 @@ If not provided, &#123;encoding&#125; defaults to 'utf8'.
<ParameterTypes parameters={[
{
"name": "str",
"type": "[WithImplicitCoercion](../types/WithImplicitCoercion.mdx)&#60;string&#62; \\| `&#123; [toPrimitive]: Method [toPrimitive] &#125;`",
"type": "[WithImplicitCoercion](../types/WithImplicitCoercion.mdx)&#60;string&#62; \\| ``{ [toPrimitive]: Method [toPrimitive] }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/BulkUpdateInventoryLevelInput.mdx
+50
View File
@@ -0,0 +1,50 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# BulkUpdateInventoryLevelInput
The attributes to update in an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
## Properties
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string`",
"description": "The ID of the associated inventory level.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/CalculatedPriceSetDTO.mdx
+32 -5
View File
@@ -13,7 +13,7 @@ A calculated price set's data.
<ParameterTypes parameters={[
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `string`",
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
"optional": false,
"defaultValue": "",
@@ -22,7 +22,7 @@ A calculated price set's data.
},
{
"name": "currency_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The currency code of the calculated price. It can possibly be `null`.",
"optional": false,
"defaultValue": "",
@@ -32,7 +32,7 @@ A calculated price set's data.
{
"name": "id",
"type": "`string`",
"description": "The ID of the price set.",
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -40,7 +40,7 @@ A calculated price set's data.
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `string`",
"description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
@@ -49,11 +49,38 @@ A calculated price set's data.
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `string`",
"description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/Context.mdx
-2
View File
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Context
The interface tag is used to ensure that the type is documented similar to interfaces.
A shared context object that is used to share resources between the application and the module.
## Type parameters
www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx
+140
View File
@@ -0,0 +1,140 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreateInventoryItemInput
The details of the inventory item to be created.
## Properties
<ParameterTypes parameters={[
{
"name": "description",
"type": "`null` \\| `string`",
"description": "The description of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "height",
"type": "`null` \\| `number`",
"description": "The height of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "hs_code",
"type": "`null` \\| `string`",
"description": "The HS code of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "length",
"type": "`null` \\| `number`",
"description": "The length of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "material",
"type": "`null` \\| `string`",
"description": "The material of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "mid_code",
"type": "`null` \\| `string`",
"description": "The MID code of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "origin_country",
"type": "`null` \\| `string`",
"description": "The origin country of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sku",
"type": "`null` \\| `string`",
"description": "The SKU of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "The thumbnail of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`null` \\| `string`",
"description": "The title of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "weight",
"type": "`null` \\| `number`",
"description": "The weight of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "width",
"type": "`null` \\| `number`",
"description": "The width of the inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/CreateInventoryLevelInput.mdx
+59
View File
@@ -0,0 +1,59 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreateInventoryLevelInput
The details of the inventory level to be created.
## Properties
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number`",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string`",
"description": "The ID of the associated inventory item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reserved_quantity",
"type": "`number`",
"description": "The reserved quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number`",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/CreateMoneyAmountDTO.mdx
+3 -3
View File
@@ -15,7 +15,7 @@ The money amount to create.
"name": "amount",
"type": "`number`",
"description": "The amount of this money amount.",
"optional": true,
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
@@ -49,7 +49,7 @@ The money amount to create.
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ The money amount to create.
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/CreatePriceListDTO.mdx
+95
View File
@@ -0,0 +1,95 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListDTO
The price list to create.
## Properties
<ParameterTypes parameters={[
{
"name": "description",
"type": "`string`",
"description": "The price list's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ends_at",
"type": "`string`",
"description": "The price list expires after this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "number_rules",
"type": "`number`",
"description": "The number of rules associated with the price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "prices",
"type": "[PriceListPriceDTO](PriceListPriceDTO.mdx)[]",
"description": "The prices associated with the price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rules",
"type": "[CreatePriceListRules](CreatePriceListRules.mdx)",
"description": "The rules to be created and associated with the price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "starts_at",
"type": "`string`",
"description": "The price list is enabled starting from this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus-2.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The price list's title.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "[PriceListType](../enums/PriceListType-2.mdx)",
"description": "The price list's type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/CreatePriceListRuleDTO.mdx
+50
View File
@@ -0,0 +1,50 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListRuleDTO
The price list rule to create.
## Properties
<ParameterTypes parameters={[
{
"name": "price_list",
"type": "`string` \\| [PriceListDTO](PriceListDTO.mdx)",
"description": "The ID of a price list or the details of an existing price list to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`string`",
"description": "The ID of a price list to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type",
"type": "`string` \\| [RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type_id",
"type": "`string`",
"description": "The ID of a rule type to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx
+10
View File
@@ -0,0 +1,10 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListRules
The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value
* is the values of the rule.
www/apps/docs/content/references/services/interfaces/CreatePriceRuleDTO.mdx
+2 -11
View File
@@ -20,15 +20,6 @@ A price rule to create.
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`string`",
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
@@ -41,7 +32,7 @@ A price rule to create.
{
"name": "price_set_money_amount_id",
"type": "`string`",
"description": "The ID of the associated price set money amount.",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -50,7 +41,7 @@ A price rule to create.
{
"name": "priority",
"type": "`number`",
"description": "The priority of the price rule in comparison to other applicable price rules.",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/CreatePriceSetDTO.mdx
+2 -2
View File
@@ -22,8 +22,8 @@ A price set to create.
},
{
"name": "rules",
"type": "`&#123; rule_attribute: string &#125;`[]",
"description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"type": "``{ rule_attribute: string }``[]",
"description": "The rules to associate with the price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/CreatePricesDTO.mdx
+3 -3
View File
@@ -15,7 +15,7 @@ The prices to create part of a price set.
"name": "amount",
"type": "`number`",
"description": "The amount of this money amount.",
"optional": true,
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
@@ -49,7 +49,7 @@ The prices to create part of a price set.
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ The prices to create part of a price set.
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/CreateReservationItemInput.mdx
+86
View File
@@ -0,0 +1,86 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreateReservationItemInput
The details of the reservation item to be created.
## Properties
<ParameterTypes parameters={[
{
"name": "created_by",
"type": "`string`",
"description": "The user or system that created the reservation. Can be any form of identification string.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The description of the reservation.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`string`",
"description": "An ID associated with an external third-party system that the reservation item is connected to.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string`",
"description": "The ID of the associated inventory item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "line_item_id",
"type": "`string`",
"description": "The ID of the associated line item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The reserved quantity.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/FilterableInventoryItemProps.mdx
+77
View File
@@ -0,0 +1,77 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterableInventoryItemProps
The filters to apply on retrieved inventory items.
## Properties
<ParameterTypes parameters={[
{
"name": "hs_code",
"type": "`string` \\| `string`[] \\| [StringComparisonOperator](StringComparisonOperator-1.mdx)",
"description": "The HS Codes to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string` \\| `string`[]",
"description": "The IDs to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string` \\| `string`[]",
"description": "Filter inventory items by the ID of their associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "origin_country",
"type": "`string` \\| `string`[]",
"description": "The origin country to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "q",
"type": "`string`",
"description": "Search term to search inventory items' attributes.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "Filter inventory items by whether they require shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sku",
"type": "`string` \\| `string`[] \\| [StringComparisonOperator](StringComparisonOperator-1.mdx)",
"description": "The SKUs to filter inventory items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/FilterableInventoryLevelProps.mdx
+59
View File
@@ -0,0 +1,59 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterableInventoryLevelProps
The filters to apply on retrieved inventory levels.
## Properties
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number` \\| [NumericalComparisonOperator](NumericalComparisonOperator-1.mdx)",
"description": "Filters to apply on inventory levels' `incoming_quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string` \\| `string`[]",
"description": "Filter inventory levels by the ID of their associated inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string` \\| `string`[]",
"description": "Filter inventory levels by the ID of their associated inventory location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reserved_quantity",
"type": "`number` \\| [NumericalComparisonOperator](NumericalComparisonOperator-1.mdx)",
"description": "Filters to apply on inventory levels' `reserved_quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number` \\| [NumericalComparisonOperator](NumericalComparisonOperator-1.mdx)",
"description": "Filters to apply on inventory levels' `stocked_quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/FilterablePriceListProps-1.mdx
+79
View File
@@ -0,0 +1,79 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterablePriceListProps
#### Inteface
Filters to apply on price lists.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceListProps](FilterablePriceListProps-1.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListProps](FilterablePriceListProps-1.mdx)&#62;)[]",
"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": "([FilterablePriceListProps](FilterablePriceListProps-1.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListProps](FilterablePriceListProps-1.mdx)&#62;)[]",
"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": "ends_at",
"type": "`string`[]",
"description": "The end dates to filter price lists by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`[]",
"description": "The IDs to filter price lists by",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "number_rules",
"type": "`number`[]",
"description": "The number of rules to filter price lists by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "starts_at",
"type": "`string`[]",
"description": "The start dates to filter price lists by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus-2.mdx)[]",
"description": "The statuses to filter price lists by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/FilterablePriceListRuleProps.mdx
+68
View File
@@ -0,0 +1,68 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterablePriceListRuleProps
Filters to apply on price list rules.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx)&#62;)[]",
"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": "([FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx)&#62;)[]",
"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`[]",
"description": "The IDs to filter price list rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`string`[]",
"description": "Filter price list rules by the ID of their associated price lists.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type",
"type": "`string`[]",
"description": "Filter price list rules by the ID of their associated rule types.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`[]",
"description": "The values to filter price list rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/FilterablePriceRuleProps.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterablePriceRuleProps
Filters to apply to price rules.
Filters to apply on price rules.
## Properties
www/apps/docs/content/references/services/interfaces/FilterablePriceSetMoneyAmountProps.mdx
+9
View File
@@ -38,6 +38,15 @@ Filters to apply on price set money amounts.
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`string`[]",
"description": "The IDs to filter the price set money amount's associated price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_id",
"type": "`string`[]",
www/apps/docs/content/references/services/interfaces/FilterableReservationItemProps.mdx
+77
View File
@@ -0,0 +1,77 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterableReservationItemProps
The filters to apply on retrieved reservation items.
## Properties
<ParameterTypes parameters={[
{
"name": "created_by",
"type": "`string` \\| `string`[]",
"description": "The \"created by\" values to filter reservation items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string` \\| [StringComparisonOperator](StringComparisonOperator-1.mdx)",
"description": "Description filters to apply on the reservation items' `description` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string` \\| `string`[]",
"description": "The IDs to filter reservation items by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventory_item_id",
"type": "`string` \\| `string`[]",
"description": "Filter reservation items by the ID of their associated inventory item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "line_item_id",
"type": "`string` \\| `string`[]",
"description": "Filter reservation items by the ID of their associated line item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string` \\| `string`[]",
"description": "Filter reservation items by the ID of their associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number` \\| [NumericalComparisonOperator](NumericalComparisonOperator-1.mdx)",
"description": "Filters to apply on the reservation items' `quantity` attribute.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/FilterableStockLocationProps.mdx
+32
View File
@@ -0,0 +1,32 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterableStockLocationProps
The filters to apply on the retrieved stock locations.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string` \\| `string`[]",
"description": "The IDs to filter stock locations by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string` \\| `string`[] \\| [StringComparisonOperator](StringComparisonOperator-1.mdx)",
"description": "The names to filter stock locations by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/IBatchJobStrategy.mdx
+1 -1
View File
@@ -315,7 +315,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/ICacheService.mdx
+3 -3
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### get
`**get**<TypeParameter T>(key): Promise&#60;`null` \| T&#62;`
`**get**<TypeParameter T>(key): Promise&#60;null \| T&#62;`
<ParameterTypes parameters={[
{
@@ -40,12 +40,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
Promise&#60;`null` \| T&#62;
Promise&#60;null \| T&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| T&#62;",
"type": "Promise&#60;null \\| T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/IInventoryService.mdx
+927 -166
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/services/interfaces/INotificationService.mdx
+1 -1
View File
@@ -276,7 +276,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ circumstances described in the context.
<ParameterTypes parameters={[
{
"name": "data",
"type": "`&#123; quantity?: number ; variantId: string &#125;`[]",
"type": "``{ quantity?: number ; variantId: string }``[]",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/IPricingModuleService.mdx
+1423 -1
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/services/interfaces/ISearchService.mdx
+1 -1
View File
@@ -324,7 +324,7 @@ Used to search for a document in an index
},
{
"name": "query",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "the search query",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx
+252 -52
View File
@@ -8,39 +8,37 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### \_\_joinerConfig
`**__joinerConfig**(): [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)`
#### Returns
[ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[Omit](../types/Omit.mdx)&#60;[JoinerServiceConfig](JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
___
### create
`**create**(input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to create a stock location.
#### Example
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function createStockLocation (name: string) {
const stockLocationModule = await initializeStockLocationModule({})
const stockLocation = await stockLocationModule.create({
name
})
// do something with the stock location or return it
}
```
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "[CreateStockLocationInput](../types/CreateStockLocationInput.mdx)",
"description": "",
"description": "The details of the stock location to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -48,8 +46,8 @@ ___
},
{
"name": "context",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"type": "[SharedContext](SharedContext.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -67,7 +65,7 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"description": "The created stock location's details.",
"expandable": false,
"children": []
}
@@ -79,13 +77,29 @@ ___
`**delete**(id, context?): Promise&#60;void&#62;`
This method is used to delete a stock location.
#### Example
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function deleteStockLocation (id:string) {
const stockLocationModule = await initializeStockLocationModule({})
await stockLocationModule.delete(id)
}
```
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"description": "The ID of the stock location.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -93,8 +107,8 @@ ___
},
{
"name": "context",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"type": "[SharedContext](SharedContext.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -112,7 +126,7 @@ Promise&#60;void&#62;
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"description": "Resolves when the stock location is successfully deleted.",
"expandable": false,
"children": []
}
@@ -124,13 +138,77 @@ ___
`**list**(selector, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;`
This method is used to retrieve a paginated list of stock locations based on optional filters and configuration.
#### Example
To retrieve a list of stock locations using their IDs:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function listStockLocations (ids: string[]) {
const stockLocationModule = await initializeStockLocationModule({})
const stockLocations = await stockLocationModule.list({
id: ids
})
// do something with the stock locations or return them
}
```
To specify relations that should be retrieved within the stock locations:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function listStockLocations (ids: string[]) {
const stockLocationModule = await initializeStockLocationModule({})
const stockLocations = await stockLocationModule.list({
id: ids
}, {
relations: ["address"]
})
// do something with the stock locations or return them
}
```
By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function listStockLocations (ids: string[], skip: number, take: number) {
const stockLocationModule = await initializeStockLocationModule({})
const stockLocations = await stockLocationModule.list({
id: ids
}, {
relations: ["address"],
skip,
take
})
// do something with the stock locations or return them
}
```
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx)",
"description": "",
"type": "[FilterableStockLocationProps](FilterableStockLocationProps.mdx)",
"description": "The filters to apply on the retrieved stock locations.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -139,7 +217,7 @@ ___
{
"name": "config",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"description": "The configurations determining how the stock locations are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a stock location.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -147,8 +225,8 @@ ___
},
{
"name": "context",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"type": "[SharedContext](SharedContext.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -166,7 +244,7 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"description": "The list of stock locations.",
"expandable": false,
"children": []
}
@@ -178,13 +256,77 @@ ___
`**listAndCount**(selector, config?, context?): Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;`
This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.
#### Example
To retrieve a list of stock locations using their IDs:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function listStockLocations (ids: string[]) {
const stockLocationModule = await initializeStockLocationModule({})
const [stockLocations, count] = await stockLocationModule.listAndCount({
id: ids
})
// do something with the stock locations or return them
}
```
To specify relations that should be retrieved within the stock locations:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function listStockLocations (ids: string[]) {
const stockLocationModule = await initializeStockLocationModule({})
const [stockLocations, count] = await stockLocationModule.listAndCount({
id: ids
}, {
relations: ["address"]
})
// do something with the stock locations or return them
}
```
By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function listStockLocations (ids: string[], skip: number, take: number) {
const stockLocationModule = await initializeStockLocationModule({})
const [stockLocations, count] = await stockLocationModule.listAndCount({
id: ids
}, {
relations: ["address"],
skip,
take
})
// do something with the stock locations or return them
}
```
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx)",
"description": "",
"type": "[FilterableStockLocationProps](FilterableStockLocationProps.mdx)",
"description": "The filters to apply on the retrieved stock locations.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -193,7 +335,7 @@ ___
{
"name": "config",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"description": "The configurations determining how the stock locations are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a stock location.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -201,8 +343,8 @@ ___
},
{
"name": "context",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"type": "[SharedContext](SharedContext.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -220,7 +362,7 @@ Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;
"type": "Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"description": "The list of stock locations along with the total count.",
"expandable": false,
"children": []
}
@@ -232,13 +374,51 @@ ___
`**retrieve**(id, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to retrieve a stock location by its ID
#### Example
A simple example that retrieves a inventory item by its ID:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function retrieveStockLocation (id: string) {
const stockLocationModule = await initializeStockLocationModule({})
const stockLocation = await stockLocationModule.retrieve(id)
// do something with the stock location or return it
}
```
To specify relations that should be retrieved:
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function retrieveStockLocation (id: string) {
const stockLocationModule = await initializeStockLocationModule({})
const stockLocation = await stockLocationModule.retrieve(id, {
relations: ["address"]
})
// do something with the stock location or return it
}
```
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"description": "The ID of the stock location",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -247,7 +427,7 @@ ___
{
"name": "config",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"description": "The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a stock location.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -255,8 +435,8 @@ ___
},
{
"name": "context",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"type": "[SharedContext](SharedContext.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -274,7 +454,7 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"description": "The stock location's details.",
"expandable": false,
"children": []
}
@@ -286,13 +466,33 @@ ___
`**update**(id, input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to update a stock location.
#### Example
```ts
import {
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"
async function updateStockLocation (id:string, name: string) {
const stockLocationModule = await initializeStockLocationModule({})
const stockLocation = await stockLocationModule.update(id, {
name
})
// do something with the stock location or return it
}
```
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"description": "The ID of the stock location.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -301,7 +501,7 @@ ___
{
"name": "input",
"type": "[UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx)",
"description": "",
"description": "The attributes to update in the stock location.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -309,8 +509,8 @@ ___
},
{
"name": "context",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"type": "[SharedContext](SharedContext.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -328,7 +528,7 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"description": "The stock location's details.",
"expandable": false,
"children": []
}
www/apps/docs/content/references/services/interfaces/IteratorReturnResult.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "done",
"type": "``true``",
"type": "`true`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/IteratorYieldResult.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "done",
"type": "``false``",
"type": "`false`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/JoinerServiceConfig.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "`&#123; relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx
+11 -2
View File
@@ -23,10 +23,10 @@ A money amount's data. A money amount represents a price.
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -64,5 +64,14 @@ A money amount's data. A money amount represents a price.
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/PriceListDTO.mdx
+113
View File
@@ -0,0 +1,113 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PriceListDTO
A price list's details.
## Properties
<ParameterTypes parameters={[
{
"name": "ends_at",
"type": "`null` \\| `string`",
"description": "The price list expires after this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The price list's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "number_rules",
"type": "`number`",
"description": "The number of rules associated with this price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "starts_at",
"type": "`null` \\| `string`",
"description": "The price list is enabled starting from this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus-2.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The price list's title.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/PriceListPriceDTO.mdx
+77
View File
@@ -0,0 +1,77 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PriceListPriceDTO
The prices associated with a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
"type": "`number`",
"description": "The amount of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency_code",
"type": "`string`",
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "max_quantity",
"type": "`null` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "min_quantity",
"type": "`null` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/PriceListRuleDTO.mdx
+59
View File
@@ -0,0 +1,59 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PriceListRuleDTO
The price list rule's details.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "The price list rule's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The value of the rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/PriceListRuleValueDTO.mdx
+41
View File
@@ -0,0 +1,41 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PriceListRuleValueDTO
The price list rule value's details.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "The price list rule value's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_rule",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)",
"description": "The associated price list rule.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The rule's value.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/PriceRuleDTO.mdx
+4 -4
View File
@@ -32,10 +32,10 @@ A price rule's data.
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"description": "The associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -68,10 +68,10 @@ A price rule's data.
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountDTO.mdx
+16 -7
View File
@@ -23,34 +23,43 @@ A price set money amount's data.
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"description": "",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "",
"description": "The ID of the associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountRulesDTO.mdx
+4 -4
View File
@@ -23,19 +23,19 @@ A price set money amount rule's data.
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"description": "The associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/services/interfaces/RemoteJoinerQuery.mdx
+1 -1
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "expands",
"type": "`&#123; args?: [JoinerArgument](JoinerArgument.mdx)[] ; directives?: &#123; [field: string]: [JoinerDirective](JoinerDirective.mdx)[]; &#125; ; fields: string[] ; property: string &#125;`[]",
"type": "``{ args?: [JoinerArgument](JoinerArgument.mdx)[] ; directives?: &#123; [field: string]: [JoinerDirective](JoinerDirective.mdx)[]; &#125; ; fields: string[] ; property: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/RemovePriceListRulesDTO.mdx
+32
View File
@@ -0,0 +1,32 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# RemovePriceListRulesDTO
The rules to remove from a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "The ID of the price list to remove rules from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rules",
"type": "`string`[]",
"description": "The rules to remove from the price list. Each item being a rule type's `rule_attribute`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/SetPriceListRulesDTO.mdx
+32
View File
@@ -0,0 +1,32 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SetPriceListRulesDTO
The rules to add to a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "The ID of the price list to add rules to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rules",
"type": "`Record<string, string \\| string[]>`",
"description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value is the value(s) of the rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"SharedArrayBuffer\"``",
"type": "`\"SharedArrayBuffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/SharedContext.mdx
+32
View File
@@ -0,0 +1,32 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SharedContext
A shared context object that is used to share resources between the application and the module.
## Properties
<ParameterTypes parameters={[
{
"name": "manager",
"type": "EntityManager",
"description": "An instance of an entity manager.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager",
"type": "EntityManager",
"description": "An instance of a transaction manager.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/UpdateInventoryLevelInput.mdx
+32
View File
@@ -0,0 +1,32 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# UpdateInventoryLevelInput
The attributes to update in an inventory level.
## Properties
<ParameterTypes parameters={[
{
"name": "incoming_quantity",
"type": "`number`",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stocked_quantity",
"type": "`number`",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/UpdateMoneyAmountDTO.mdx
-2
View File
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# UpdateMoneyAmountDTO
*
The data to update in a money amount. The `id` is used to identify which money amount to update.
## Properties
www/apps/docs/content/references/services/interfaces/UpdatePriceListDTO.mdx
+77
View File
@@ -0,0 +1,77 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# UpdatePriceListDTO
The attributes to update in a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "ends_at",
"type": "`string`",
"description": "The price list expires after this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the price list to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "number_rules",
"type": "`number`",
"description": "The number of rules associated with the price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rules",
"type": "[CreatePriceListRules](CreatePriceListRules.mdx)",
"description": "The rules to be created and associated with the price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "starts_at",
"type": "`string`",
"description": "The price list is enabled starting from this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus-2.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The price list's title.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/UpdatePriceListRuleDTO.mdx
+59
View File
@@ -0,0 +1,59 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# UpdatePriceListRuleDTO
The attributes to update in a price list rule.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "The ID of the price list rule to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list",
"type": "`string`",
"description": "The ID of a price list to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`string`",
"description": "The ID of a price list to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type",
"type": "`string`",
"description": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type_id",
"type": "`string`",
"description": "The ID of a rule type to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/services/interfaces/UpdatePriceRuleDTO.mdx
+3 -3
View File
@@ -14,7 +14,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
{
"name": "id",
"type": "`string`",
"description": "The ID of the price rule to update.",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -32,7 +32,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -59,7 +59,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
{
"name": "rule_type_id",
"type": "`string`",
"description": "The ID of the associated rule type.",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/UpdateReservationItemInput.mdx
+50
View File
@@ -0,0 +1,50 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# UpdateReservationItemInput
The attributes to update in a reservation item.
## Properties
<ParameterTypes parameters={[
{
"name": "description",
"type": "`string`",
"description": "The description of the reservation item.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "The ID of the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The reserved quantity.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />