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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/docs/content/references/entities/classes/MoneyAmount.mdx
View File

@@ -332,7 +332,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "region_id",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",

2
www/apps/docs/content/references/entities/classes/PriceList.mdx
View File

@@ -266,7 +266,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "region_id",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",

2
www/apps/docs/content/references/entities/classes/ProductVariant.mdx
View File

@@ -437,7 +437,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "region_id",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",

4
www/apps/docs/content/references/entities/enums/AllocationType.mdx
View File

@@ -10,7 +10,7 @@ The scope that the discount should apply to.
## Enumeration Members
### ITEM
#### ITEM
**ITEM** = `"item"`
@@ -18,7 +18,7 @@ The discount should be applied to applicable items in the cart.
___
### TOTAL
#### TOTAL
**TOTAL** = `"total"`

14
www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx
View File

@@ -8,42 +8,42 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
___
### COMPLETED
#### COMPLETED
**COMPLETED** = `"completed"`
___
### CONFIRMED
#### CONFIRMED
**CONFIRMED** = `"confirmed"`
___
### CREATED
#### CREATED
**CREATED** = `"created"`
___
### FAILED
#### FAILED
**FAILED** = `"failed"`
___
### PRE\_PROCESSED
#### PRE\_PROCESSED
**PRE\_PROCESSED** = `"pre_processed"`
___
### PROCESSING
#### PROCESSING
**PROCESSING** = `"processing"`

10
www/apps/docs/content/references/entities/enums/CartType.mdx
View File

@@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### CLAIM
#### CLAIM
**CLAIM** = `"claim"`
___
### DEFAULT
#### DEFAULT
**DEFAULT** = `"default"`
___
### DRAFT\_ORDER
#### DRAFT\_ORDER
**DRAFT\_ORDER** = `"draft_order"`
___
### PAYMENT\_LINK
#### PAYMENT\_LINK
**PAYMENT\_LINK** = `"payment_link"`
___
### SWAP
#### SWAP
**SWAP** = `"swap"`

18
www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx
View File

@@ -10,7 +10,7 @@ The claim's fulfillment status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The claim's fulfillments are canceled.
___
### FULFILLED
#### FULFILLED
**FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The claim's replacement items are fulfilled.
___
### NOT\_FULFILLED
#### NOT\_FULFILLED
**NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,7 +34,7 @@ The claim's replacement items are not fulfilled.
___
### PARTIALLY\_FULFILLED
#### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
@@ -42,7 +42,7 @@ Some of the claim's replacement items, but not all, are fulfilled.
___
### PARTIALLY\_RETURNED
#### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = `"partially_returned"`
@@ -50,7 +50,7 @@ Some of the claim's items, but not all, are returned.
___
### PARTIALLY\_SHIPPED
#### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
@@ -58,7 +58,7 @@ Some of the claim's replacement items, but not all, are shipped.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -66,7 +66,7 @@ The claim's fulfillment requires action.
___
### RETURNED
#### RETURNED
**RETURNED** = `"returned"`
@@ -74,7 +74,7 @@ The claim's items are returned.
___
### SHIPPED
#### SHIPPED
**SHIPPED** = `"shipped"`

6
www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx
View File

@@ -10,7 +10,7 @@ The claim's payment status
## Enumeration Members
### NA
#### NA
**NA** = `"na"`
@@ -18,7 +18,7 @@ The payment status isn't set, which is typically used when the claim's type is `
___
### NOT\_REFUNDED
#### NOT\_REFUNDED
**NOT\_REFUNDED** = `"not_refunded"`
@@ -26,7 +26,7 @@ The payment isn't refunded.
___
### REFUNDED
#### REFUNDED
**REFUNDED** = `"refunded"`

8
www/apps/docs/content/references/entities/enums/ClaimReason.mdx
View File

@@ -8,24 +8,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### MISSING\_ITEM
#### MISSING\_ITEM
**MISSING\_ITEM** = `"missing_item"`
___
### OTHER
#### OTHER
**OTHER** = `"other"`
___
### PRODUCTION\_FAILURE
#### PRODUCTION\_FAILURE
**PRODUCTION\_FAILURE** = `"production_failure"`
___
### WRONG\_ITEM
#### WRONG\_ITEM
**WRONG\_ITEM** = `"wrong_item"`

4
www/apps/docs/content/references/entities/enums/ClaimType.mdx
View File

@@ -10,7 +10,7 @@ The claim's type.
## Enumeration Members
### REFUND
#### REFUND
**REFUND** = `"refund"`
@@ -18,7 +18,7 @@ The claim refunds an amount to the customer.
___
### REPLACE
#### REPLACE
**REPLACE** = `"replace"`

4
www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx
View File

@@ -10,7 +10,7 @@ The possible operators used for a discount condition.
## Enumeration Members
### IN
#### IN
**IN** = `"in"`
@@ -18,7 +18,7 @@ The discountable resources are within the specified resources.
___
### NOT\_IN
#### NOT\_IN
**NOT\_IN** = `"not_in"`

10
www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx
View File

@@ -10,7 +10,7 @@ The discount condition's type.
## Enumeration Members
### CUSTOMER\_GROUPS
#### CUSTOMER\_GROUPS
**CUSTOMER\_GROUPS** = `"customer_groups"`
@@ -18,7 +18,7 @@ The discount condition is used for customer groups.
___
### PRODUCTS
#### PRODUCTS
**PRODUCTS** = `"products"`
@@ -26,7 +26,7 @@ The discount condition is used for products.
___
### PRODUCT\_COLLECTIONS
#### PRODUCT\_COLLECTIONS
**PRODUCT\_COLLECTIONS** = `"product_collections"`
@@ -34,7 +34,7 @@ The discount condition is used for product collections.
___
### PRODUCT\_TAGS
#### PRODUCT\_TAGS
**PRODUCT\_TAGS** = `"product_tags"`
@@ -42,7 +42,7 @@ The discount condition is used for product tags.
___
### PRODUCT\_TYPES
#### PRODUCT\_TYPES
**PRODUCT\_TYPES** = `"product_types"`

6
www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx
View File

@@ -10,7 +10,7 @@ The possible types of discount rules.
## Enumeration Members
### FIXED
#### FIXED
**FIXED** = `"fixed"`
@@ -18,7 +18,7 @@ Discounts that reduce the price by a fixed amount.
___
### FREE\_SHIPPING
#### FREE\_SHIPPING
**FREE\_SHIPPING** = `"free_shipping"`
@@ -26,7 +26,7 @@ Discounts that sets the shipping price to `0`.
___
### PERCENTAGE
#### PERCENTAGE
**PERCENTAGE** = `"percentage"`

4
www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx
View File

@@ -10,7 +10,7 @@ The draft order's status.
## Enumeration Members
### COMPLETED
#### COMPLETED
**COMPLETED** = `"completed"`
@@ -18,7 +18,7 @@ The draft order is completed, and an order has been created from it.
___
### OPEN
#### OPEN
**OPEN** = `"open"`

18
www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx
View File

@@ -10,7 +10,7 @@ The order's fulfillment status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The order's fulfillments are canceled.
___
### FULFILLED
#### FULFILLED
**FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The order's items are fulfilled.
___
### NOT\_FULFILLED
#### NOT\_FULFILLED
**NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,7 +34,7 @@ The order's items are not fulfilled.
___
### PARTIALLY\_FULFILLED
#### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
@@ -42,7 +42,7 @@ Some of the order's items, but not all, are fulfilled.
___
### PARTIALLY\_RETURNED
#### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = `"partially_returned"`
@@ -50,7 +50,7 @@ Some of the order's items, but not all, are returned.
___
### PARTIALLY\_SHIPPED
#### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
@@ -58,7 +58,7 @@ Some of the order's items, but not all, are shipped.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -66,7 +66,7 @@ The order's fulfillment requires action.
___
### RETURNED
#### RETURNED
**RETURNED** = `"returned"`
@@ -74,7 +74,7 @@ The order's items are returned.
___
### SHIPPED
#### SHIPPED
**SHIPPED** = `"shipped"`

6
www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx
View File

@@ -10,7 +10,7 @@ The type of the order edit item change.
## Enumeration Members
### ITEM\_ADD
#### ITEM\_ADD
**ITEM\_ADD** = `"item_add"`
@@ -18,7 +18,7 @@ A new item to be added to the original order.
___
### ITEM\_REMOVE
#### ITEM\_REMOVE
**ITEM\_REMOVE** = `"item_remove"`
@@ -26,7 +26,7 @@ An existing item to be removed from the original order.
___
### ITEM\_UPDATE
#### ITEM\_UPDATE
**ITEM\_UPDATE** = `"item_update"`

10
www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx
View File

@@ -10,7 +10,7 @@ The order edit's status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The order edit is canceled.
___
### CONFIRMED
#### CONFIRMED
**CONFIRMED** = `"confirmed"`
@@ -26,7 +26,7 @@ The order edit is confirmed.
___
### CREATED
#### CREATED
**CREATED** = `"created"`
@@ -34,7 +34,7 @@ The order edit is created.
___
### DECLINED
#### DECLINED
**DECLINED** = `"declined"`
@@ -42,7 +42,7 @@ The order edit is declined.
___
### REQUESTED
#### REQUESTED
**REQUESTED** = `"requested"`

10
www/apps/docs/content/references/entities/enums/OrderStatus.mdx
View File

@@ -10,7 +10,7 @@ The order's status.
## Enumeration Members
### ARCHIVED
#### ARCHIVED
**ARCHIVED** = `"archived"`
@@ -18,7 +18,7 @@ The order is archived.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The order is canceled.
___
### COMPLETED
#### COMPLETED
**COMPLETED** = `"completed"`
@@ -36,7 +36,7 @@ has been captured.
___
### PENDING
#### PENDING
**PENDING** = `"pending"`
@@ -44,7 +44,7 @@ The order is pending.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`

10
www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx
View File

@@ -10,7 +10,7 @@ The payment collection's status.
## Enumeration Members
### AUTHORIZED
#### AUTHORIZED
**AUTHORIZED** = `"authorized"`
@@ -18,7 +18,7 @@ The payment colleciton is authorized.
___
### AWAITING
#### AWAITING
**AWAITING** = `"awaiting"`
@@ -26,7 +26,7 @@ The payment collection is awaiting payment.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -34,7 +34,7 @@ The payment collection is canceled.
___
### NOT\_PAID
#### NOT\_PAID
**NOT\_PAID** = `"not_paid"`
@@ -42,7 +42,7 @@ The payment collection isn't paid.
___
### PARTIALLY\_AUTHORIZED
#### PARTIALLY\_AUTHORIZED
**PARTIALLY\_AUTHORIZED** = `"partially_authorized"`

2
www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx
View File

@@ -10,7 +10,7 @@ The payment collection's type.
## Enumeration Members
### ORDER\_EDIT
#### ORDER\_EDIT
**ORDER\_EDIT** = `"order_edit"`

10
www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx
View File

@@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### AUTHORIZED
#### AUTHORIZED
**AUTHORIZED** = `"authorized"`
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
___
### ERROR
#### ERROR
**ERROR** = `"error"`
___
### PENDING
#### PENDING
**PENDING** = `"pending"`
___
### REQUIRES\_MORE
#### REQUIRES\_MORE
**REQUIRES\_MORE** = `"requires_more"`

14
www/apps/docs/content/references/entities/enums/PaymentStatus.mdx
View File

@@ -10,7 +10,7 @@ The order's payment status.
## Enumeration Members
### AWAITING
#### AWAITING
**AWAITING** = `"awaiting"`
@@ -18,7 +18,7 @@ The order's payment is awaiting capturing.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The order's payment is canceled.
___
### CAPTURED
#### CAPTURED
**CAPTURED** = `"captured"`
@@ -34,7 +34,7 @@ The order's payment is captured.
___
### NOT\_PAID
#### NOT\_PAID
**NOT\_PAID** = `"not_paid"`
@@ -42,7 +42,7 @@ The order's payment is not paid.
___
### PARTIALLY\_REFUNDED
#### PARTIALLY\_REFUNDED
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
@@ -50,7 +50,7 @@ Some of the order's payment amount is refunded.
___
### REFUNDED
#### REFUNDED
**REFUNDED** = `"refunded"`
@@ -58,7 +58,7 @@ The order's payment amount is refunded.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`

4
www/apps/docs/content/references/entities/enums/PriceListStatus.mdx
View File

@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### ACTIVE
#### ACTIVE
**ACTIVE** = `"active"`
___
### DRAFT
#### DRAFT
**DRAFT** = `"draft"`

4
www/apps/docs/content/references/entities/enums/PriceListType.mdx
View File

@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### OVERRIDE
#### OVERRIDE
**OVERRIDE** = `"override"`
___
### SALE
#### SALE
**SALE** = `"sale"`

8
www/apps/docs/content/references/entities/enums/ProductStatus.mdx
View File

@@ -10,7 +10,7 @@ The status of a product.
## Enumeration Members
### DRAFT
#### DRAFT
**DRAFT** = `"draft"`
@@ -18,7 +18,7 @@ The product is a draft. It's not viewable by customers.
___
### PROPOSED
#### PROPOSED
**PROPOSED** = `"proposed"`
@@ -26,7 +26,7 @@ The product is proposed, but not yet published.
___
### PUBLISHED
#### PUBLISHED
**PUBLISHED** = `"published"`
@@ -34,7 +34,7 @@ The product is published.
___
### REJECTED
#### REJECTED
**REJECTED** = `"rejected"`

10
www/apps/docs/content/references/entities/enums/RefundReason.mdx
View File

@@ -10,7 +10,7 @@ The reason of the refund.
## Enumeration Members
### CLAIM
#### CLAIM
**CLAIM** = `"claim"`
@@ -18,7 +18,7 @@ The refund is applied because of a created claim.
___
### DISCOUNT
#### DISCOUNT
**DISCOUNT** = `"discount"`
@@ -26,7 +26,7 @@ The refund is applied as a discount.
___
### OTHER
#### OTHER
**OTHER** = `"other"`
@@ -34,7 +34,7 @@ The refund is created for a custom reason.
___
### RETURN
#### RETURN
**RETURN** = `"return"`
@@ -42,7 +42,7 @@ The refund is applied because of a created return.
___
### SWAP
#### SWAP
**SWAP** = `"swap"`

4
www/apps/docs/content/references/entities/enums/RequirementType.mdx
View File

@@ -10,7 +10,7 @@ The type of shipping option requirement.
## Enumeration Members
### MAX\_SUBTOTAL
#### MAX\_SUBTOTAL
**MAX\_SUBTOTAL** = `"max_subtotal"`
@@ -18,7 +18,7 @@ The shipping option can only be applied if the subtotal is less than the require
___
### MIN\_SUBTOTAL
#### MIN\_SUBTOTAL
**MIN\_SUBTOTAL** = `"min_subtotal"`

8
www/apps/docs/content/references/entities/enums/ReturnStatus.mdx
View File

@@ -10,7 +10,7 @@ The return's status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The return is canceled.
___
### RECEIVED
#### RECEIVED
**RECEIVED** = `"received"`
@@ -26,7 +26,7 @@ The return is received.
___
### REQUESTED
#### REQUESTED
**REQUESTED** = `"requested"`
@@ -34,7 +34,7 @@ The return is requested.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`

4
www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx
View File

@@ -10,7 +10,7 @@ The type of the shipping option price.
## Enumeration Members
### CALCULATED
#### CALCULATED
**CALCULATED** = `"calculated"`
@@ -18,7 +18,7 @@ The shipping option's price is calculated. In this case, the `amount` field is t
___
### FLAT\_RATE
#### FLAT\_RATE
**FLAT\_RATE** = `"flat_rate"`

6
www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx
View File

@@ -10,7 +10,7 @@ The shipping profile's type.
## Enumeration Members
### CUSTOM
#### CUSTOM
**CUSTOM** = `"custom"`
@@ -18,7 +18,7 @@ The profile used to ship custom items.
___
### DEFAULT
#### DEFAULT
**DEFAULT** = `"default"`
@@ -26,7 +26,7 @@ The default profile used to ship item.
___
### GIFT\_CARD
#### GIFT\_CARD
**GIFT\_CARD** = `"gift_card"`

12
www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx
View File

@@ -10,7 +10,7 @@ The swap's fulfillment status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The swap's fulfillments are canceled.
___
### FULFILLED
#### FULFILLED
**FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The swap's items are fulfilled.
___
### NOT\_FULFILLED
#### NOT\_FULFILLED
**NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,7 +34,7 @@ The swap's items aren't fulfilled.
___
### PARTIALLY\_SHIPPED
#### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
@@ -42,7 +42,7 @@ Some of the swap's items are shipped.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -50,7 +50,7 @@ The swap's fulfillments require an action.
___
### SHIPPED
#### SHIPPED
**SHIPPED** = `"shipped"`

18
www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx
View File

@@ -10,7 +10,7 @@ The swap's payment status.
## Enumeration Members
### AWAITING
#### AWAITING
**AWAITING** = `"awaiting"`
@@ -18,7 +18,7 @@ The swap is additional awaiting payment.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The swap's additional payment is canceled.
___
### CAPTURED
#### CAPTURED
**CAPTURED** = `"captured"`
@@ -34,7 +34,7 @@ The swap's additional payment is captured.
___
### CONFIRMED
#### CONFIRMED
**CONFIRMED** = `"confirmed"`
@@ -42,7 +42,7 @@ The swap's additional payment is confirmed.
___
### DIFFERENCE\_REFUNDED
#### DIFFERENCE\_REFUNDED
**DIFFERENCE\_REFUNDED** = `"difference_refunded"`
@@ -50,7 +50,7 @@ The negative difference amount between the returned item(s) and the new one(s) h
___
### NOT\_PAID
#### NOT\_PAID
**NOT\_PAID** = `"not_paid"`
@@ -58,7 +58,7 @@ The swap's additional payment isn't paid.
___
### PARTIALLY\_REFUNDED
#### PARTIALLY\_REFUNDED
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
@@ -66,7 +66,7 @@ Some of the negative difference amount between the returned item(s) and the new
___
### REFUNDED
#### REFUNDED
**REFUNDED** = `"refunded"`
@@ -74,7 +74,7 @@ The amount in the associated order has been refunded.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`

6
www/apps/docs/content/references/entities/enums/UserRoles.mdx
View File

@@ -10,7 +10,7 @@ The user's role. These roles don't change the user's capabilities or provide acc
## Enumeration Members
### ADMIN
#### ADMIN
**ADMIN** = `"admin"`
@@ -18,7 +18,7 @@ The user is an admin.
___
### DEVELOPER
#### DEVELOPER
**DEVELOPER** = `"developer"`
@@ -26,7 +26,7 @@ The user is a developer.
___
### MEMBER
#### MEMBER
**MEMBER** = `"member"`

8
www/apps/docs/content/references/entities/index.mdx
View File

@@ -137,10 +137,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Functions
### Boolean
#### Boolean
`**Boolean**<TypeParameter T>(value?): boolean`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -153,7 +155,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -167,7 +169,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
`boolean`

4
www/apps/docs/content/references/entities/types/BatchJobResultError.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**BatchJobResultError**: `Object`
### Index signature
#### Index signature
▪ [key: `string`]: `unknown`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/entities/types/BatchJobResultStatDescriptor.mdx
View File

@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**BatchJobResultStatDescriptor**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/entities/types/Record.mdx
View File

@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Record
**Record**`<TypeParameter K, TypeParameter T>`: &#123; [P in K]: T &#125;
**Record**: &#123; [P in K]: T &#125;
Construct a type with a set of properties K of type T
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

16
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listInventoryItems.mdx
View File

@@ -165,17 +165,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -197,7 +187,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -206,7 +196,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

16
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listInventoryLevels.mdx
View File

@@ -147,17 +147,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -179,7 +169,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -188,7 +178,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

16
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listReservationItems.mdx
View File

@@ -165,17 +165,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -197,7 +187,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -206,7 +196,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

16
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx
View File

@@ -75,17 +75,7 @@ async function retrieveInventoryItem (id: string) {
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -107,7 +97,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -116,7 +106,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

18
www/apps/docs/content/references/inventory/interfaces/FindConfig.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FindConfig
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
which provides correct typing of field names in its properties.
## Type parameters
@@ -33,17 +33,7 @@ which provides correct typing of field names in its properties.
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -65,7 +55,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -74,7 +64,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

4
www/apps/docs/content/references/inventory/types/Exclude.mdx
View File

@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Exclude
**Exclude**`<TypeParameter T, TypeParameter U>`: `T` extends `U` ? `never` : `T`
**Exclude**: `T` extends `U` ? `never` : `T`
Exclude from T those types that are assignable to U
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx
View File

@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**InventoryItemDTO**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx
View File

@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**InventoryLevelDTO**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/inventory/types/JoinerRelationship.mdx
View File

@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**JoinerRelationship**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/inventory/types/Omit.mdx
View File

@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Omit
**Omit**`<TypeParameter T, TypeParameter K>`: [Pick](Pick.mdx)&#60;T, [Exclude](Exclude.mdx)&#60;keyof T, K&#62;&#62;
**Omit**: [Pick](Pick.mdx)&#60;T, [Exclude](Exclude.mdx)&#60;keyof T, K&#62;&#62;
Construct a type with the properties of T except for those in type K.
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/inventory/types/Partial.mdx
View File

@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Partial
**Partial**`<TypeParameter T>`: &#123; [P in keyof T]?: T[P] &#125;
**Partial**: &#123; [P in keyof T]?: T[P] &#125;
Make all properties in T optional
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/inventory/types/Pick.mdx
View File

@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Pick
**Pick**`<TypeParameter T, TypeParameter K>`: &#123; [P in K]: T[P] &#125;
**Pick**: &#123; [P in K]: T[P] &#125;
From T, pick a set of properties whose keys are in the union K
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/inventory/types/Record.mdx
View File

@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Record
**Record**`<TypeParameter K, TypeParameter T>`: &#123; [P in K]: T &#125;
**Record**: &#123; [P in K]: T &#125;
Construct a type with a set of properties K of type T
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx
View File

@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Represents a reservation of an inventory item at a stock location
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

18
www/apps/docs/content/references/js-client/CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx
View File

@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### get
#### get
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -40,9 +40,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
### invalidate
#### invalidate
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -72,9 +72,9 @@ ___
___
### set
#### set
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -106,7 +106,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/js-client/CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx
View File

@@ -55,7 +55,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -64,7 +64,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ConfigModule
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ExtendedFindConfig.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ExtendedFindConfig
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.HttpCompressionOptions.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# HttpCompressionOptions
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.PartialPick.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# PartialPick
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ProjectConfigOptions
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.QueryConfig.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# QueryConfig
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.QuerySelector.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# QuerySelector
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.RequestQueryFields.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# RequestQueryFields
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.Selector.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Selector
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.TreeQuerySelector.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# TreeQuerySelector
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.WithRequiredProperty.mdx
View File

@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Utility type used to remove some optional attributes (coming from K) from a type T
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.Writable.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Writable
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

86
www/apps/docs/content/references/js-client/DAL/interfaces/internal.internal-1.DAL.RepositoryService.mdx
View File

@@ -26,9 +26,9 @@ ORM directly and allows to switch to another ORM without changing the business l
## Methods
### create
#### create
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -51,7 +51,7 @@ ORM directly and allows to switch to another ORM without changing the business l
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -67,9 +67,9 @@ ORM directly and allows to switch to another ORM without changing the business l
___
### delete
#### delete
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -92,7 +92,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -108,9 +108,9 @@ ___
___
### find
#### find
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -133,7 +133,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -149,9 +149,9 @@ ___
___
### findAndCount
#### findAndCount
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -174,7 +174,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -190,25 +190,45 @@ ___
___
### getActiveManager
#### getActiveManager
#### Returns
##### Returns
<ParameterTypes parameters={[]} />
<ParameterTypes parameters={[
{
"name": "TManager",
"type": "`TManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### getFreshManager
#### getFreshManager
#### Returns
##### Returns
<ParameterTypes parameters={[]} />
<ParameterTypes parameters={[
{
"name": "TManager",
"type": "`TManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### restore
#### restore
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -231,7 +251,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -247,9 +267,9 @@ ___
___
### serialize
#### serialize
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -272,7 +292,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -288,11 +308,11 @@ ___
___
### softDelete
#### softDelete
Soft delete entities and cascade to related entities if configured.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -315,7 +335,7 @@ Soft delete entities and cascade to related entities if configured.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -331,9 +351,9 @@ Soft delete entities and cascade to related entities if configured.
___
### transaction
#### transaction
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -383,7 +403,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -399,9 +419,9 @@ ___
___
### update
#### update
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -424,7 +444,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

68
www/apps/docs/content/references/js-client/DAL/interfaces/internal.internal-1.DAL.TreeRepositoryService.mdx
View File

@@ -26,9 +26,9 @@ ORM directly and allows to switch to another ORM without changing the business l
## Methods
### create
#### create
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -51,7 +51,7 @@ ORM directly and allows to switch to another ORM without changing the business l
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -67,9 +67,9 @@ ORM directly and allows to switch to another ORM without changing the business l
___
### delete
#### delete
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -92,7 +92,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -108,9 +108,9 @@ ___
___
### find
#### find
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -142,7 +142,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -158,9 +158,9 @@ ___
___
### findAndCount
#### findAndCount
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +192,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -208,25 +208,45 @@ ___
___
### getActiveManager
#### getActiveManager
#### Returns
##### Returns
<ParameterTypes parameters={[]} />
<ParameterTypes parameters={[
{
"name": "TManager",
"type": "`TManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### getFreshManager
#### getFreshManager
#### Returns
##### Returns
<ParameterTypes parameters={[]} />
<ParameterTypes parameters={[
{
"name": "TManager",
"type": "`TManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### serialize
#### serialize
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -249,7 +269,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -265,9 +285,9 @@ ___
___
### transaction
#### transaction
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -317,7 +337,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/DAL/types/internal.internal-1.DAL.FilterQuery.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterQuery
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/js-client/DAL/types/internal.internal-1.DAL.FindOptions.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FindOptions
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

22
www/apps/docs/content/references/js-client/EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### emit
#### emit
`**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -44,7 +44,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -60,7 +60,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**emit**<TypeParameter T>(data): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -90,9 +90,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
### subscribe
#### subscribe
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -124,7 +124,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -140,9 +140,9 @@ ___
___
### unsubscribe
#### unsubscribe
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -174,7 +174,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

24
www/apps/docs/content/references/js-client/EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx
View File

@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### emit
#### emit
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -58,9 +58,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
### subscribe
#### subscribe
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -92,7 +92,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -108,9 +108,9 @@ ___
___
### unsubscribe
#### unsubscribe
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -142,7 +142,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -158,9 +158,9 @@ ___
___
### withTransaction
#### withTransaction
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -174,7 +174,7 @@ ___
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# EmitData
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.EventHandler.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# EventHandler
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
### Type declaration
#### Type declaration
##### Parameters

4
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Subscriber
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
### Type declaration
#### Type declaration
##### Parameters

2
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SubscriberContext
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberDescriptor.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SubscriberDescriptor
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

142
www/apps/docs/content/references/js-client/EventEmitter/classes/internal.EventEmitter.EventEmitterAsyncResource.mdx
View File

@@ -91,9 +91,9 @@ v17.4.0, v16.14.0
## Methods
### [captureRejectionSymbol]
#### [captureRejectionSymbol]
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -125,7 +125,7 @@ v17.4.0, v16.14.0
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -141,11 +141,11 @@ v17.4.0, v16.14.0
___
### addListener
#### addListener
Alias for `emitter.on(eventName, listener)`.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -168,7 +168,7 @@ Alias for `emitter.on(eventName, listener)`.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -188,7 +188,7 @@ v0.1.26
___
### emit
#### emit
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -228,7 +228,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
// event with parameters 1, 2, 3, 4, 5 in third listener
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -251,7 +251,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -271,14 +271,14 @@ v0.1.26
___
### emitDestroy
#### emitDestroy
Call all destroy hooks. This should only ever be called once. An
error will be thrown if it is called more than once. This must be
manually called. If the resource is left to be collected by the GC then
the destroy hooks will never be called.
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -294,7 +294,7 @@ the destroy hooks will never be called.
___
### eventNames
#### eventNames
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -313,7 +313,7 @@ console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
```
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -333,12 +333,12 @@ v6.0.0
___
### getMaxListeners
#### getMaxListeners
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal.EventEmitter.EventEmitterAsyncResource.mdx#defaultmaxlisteners).
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -358,13 +358,13 @@ v1.0.0
___
### listenerCount
#### listenerCount
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
in the list of the listeners of the event.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -387,7 +387,7 @@ in the list of the listeners of the event.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -407,7 +407,7 @@ v3.2.0
___
### listeners
#### listeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -419,7 +419,7 @@ console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -433,7 +433,7 @@ console.log(util.inspect(server.listeners('connection')));
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -453,11 +453,11 @@ v0.1.26
___
### off
#### off
Alias for `emitter.removeListener()`.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -480,7 +480,7 @@ Alias for `emitter.removeListener()`.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -500,7 +500,7 @@ v10.0.0
___
### on
#### on
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -529,7 +529,7 @@ myEE.emit('foo');
// a
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -552,7 +552,7 @@ myEE.emit('foo');
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -572,7 +572,7 @@ v0.1.101
___
### once
#### once
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -599,7 +599,7 @@ myEE.emit('foo');
// a
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -622,7 +622,7 @@ myEE.emit('foo');
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -642,7 +642,7 @@ v0.3.0
___
### prependListener
#### prependListener
Adds the `listener` function to the \_beginning\_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -657,7 +657,7 @@ server.prependListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -680,7 +680,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -700,7 +700,7 @@ v6.0.0
___
### prependOnceListener
#### prependOnceListener
Adds a **one-time**`listener` function for the event named `eventName` to the \_beginning\_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -713,7 +713,7 @@ server.prependOnceListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -736,7 +736,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -756,7 +756,7 @@ v6.0.0
___
### rawListeners
#### rawListeners
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -786,7 +786,7 @@ newListeners[0]();
emitter.emit('log');
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -800,7 +800,7 @@ emitter.emit('log');
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -820,7 +820,7 @@ v9.4.0
___
### removeAllListeners
#### removeAllListeners
Removes all listeners, or those of the specified `eventName`.
@@ -830,7 +830,7 @@ component or module (e.g. sockets or file streams).
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -844,7 +844,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -864,7 +864,7 @@ v0.1.26
___
### removeListener
#### removeListener
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -946,7 +946,7 @@ ee.emit('ping');
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -969,7 +969,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -989,7 +989,7 @@ v0.1.26
___
### setMaxListeners
#### setMaxListeners
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -998,7 +998,7 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1012,7 +1012,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1032,7 +1032,7 @@ v0.3.5
___
### addAbortListener
#### addAbortListener
Listens once to the `abort` event on the provided `signal`.
@@ -1064,7 +1064,7 @@ function example(signal) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1087,7 +1087,7 @@ function example(signal) {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1107,7 +1107,7 @@ v20.5.0
___
### getEventListeners
#### getEventListeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1134,7 +1134,7 @@ import { getEventListeners, EventEmitter } from 'node:events';
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1157,7 +1157,7 @@ import { getEventListeners, EventEmitter } from 'node:events';
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1177,7 +1177,7 @@ v15.2.0, v14.17.0
___
### getMaxListeners
#### getMaxListeners
Returns the currently set max amount of listeners.
@@ -1205,7 +1205,7 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1219,7 +1219,7 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1239,7 +1239,7 @@ v19.9.0
___
### listenerCount
#### listenerCount
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -1253,7 +1253,7 @@ console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1276,7 +1276,7 @@ console.log(listenerCount(myEmitter, 'event'));
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1300,7 +1300,7 @@ Since v3.2.0 - Use `listenerCount` instead.
___
### on
#### on
```js
import { on, EventEmitter } from 'node:events';
@@ -1357,7 +1357,7 @@ const ac = new AbortController();
process.nextTick(() => ac.abort());
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1389,7 +1389,7 @@ process.nextTick(() => ac.abort());
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1409,7 +1409,7 @@ v13.6.0, v12.16.0
___
### once
#### once
`Static **once**(emitter, eventName, options?): Promise&#60;any[]&#62;`
@@ -1490,7 +1490,7 @@ ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1522,7 +1522,7 @@ ee.emit('foo'); // Prints: Waiting for the event was canceled!
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1542,7 +1542,7 @@ v11.13.0, v10.16.0
`Static **once**(emitter, eventName, options?): Promise&#60;any[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1574,7 +1574,7 @@ v11.13.0, v10.16.0
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1590,7 +1590,7 @@ v11.13.0, v10.16.0
___
### setMaxListeners
#### setMaxListeners
```js
import { setMaxListeners, EventEmitter } from 'node:events';
@@ -1601,7 +1601,7 @@ const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1624,7 +1624,7 @@ setMaxListeners(5, target, emitter);
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

48
www/apps/docs/content/references/js-client/EventEmitter/interfaces/internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx
View File

@@ -58,9 +58,9 @@ asyncResource.triggerAsyncId();
## Methods
### asyncId
#### asyncId
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -76,11 +76,11 @@ asyncResource.triggerAsyncId();
___
### bind
#### bind
Binds the given function to execute to this `AsyncResource`'s scope.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -94,9 +94,19 @@ Binds the given function to execute to this `AsyncResource`'s scope.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[]} />
<ParameterTypes parameters={[
{
"name": "Func",
"type": "`Func`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
#### Since
@@ -104,14 +114,14 @@ v14.8.0, v12.19.0
___
### emitDestroy
#### emitDestroy
Call all `destroy` hooks. This should only ever be called once. An error will
be thrown if it is called more than once. This **must** be manually called. If
the resource is left to be collected by the GC then the `destroy` hooks will
never be called.
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -127,14 +137,14 @@ never be called.
___
### runInAsyncScope
#### runInAsyncScope
Call the provided function with the provided arguments in the execution context
of the async resource. This will establish the context, trigger the AsyncHooks
before callbacks, call the function, trigger the AsyncHooks after callbacks, and
then restore the original execution context.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -166,9 +176,19 @@ then restore the original execution context.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[]} />
<ParameterTypes parameters={[
{
"name": "Result",
"type": "`Result`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
#### Since
@@ -176,9 +196,9 @@ v9.6.0
___
### triggerAsyncId
#### triggerAsyncId
#### Returns
##### Returns
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/FeatureFlagTypes/types/internal.internal-1.FeatureFlagTypes.FlagSettings.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FlagSettings
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

224
www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### adjustInventory
#### adjustInventory
This method is used to adjust the inventory level's stocked quantity. The inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -36,7 +36,7 @@ async function adjustInventory (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -77,7 +77,7 @@ async function adjustInventory (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -93,11 +93,11 @@ async function adjustInventory (
___
### confirmInventory
#### confirmInventory
This method is used to confirm whether the specified quantity of an inventory item is available in the specified locations.
#### Example
##### Example
```ts
import {
@@ -119,7 +119,7 @@ async function confirmInventory (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -160,7 +160,7 @@ async function confirmInventory (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -176,11 +176,11 @@ async function confirmInventory (
___
### createInventoryItem
#### createInventoryItem
This method is used to create an inventory item.
#### Example
##### Example
```ts
import {
@@ -201,7 +201,7 @@ async function createInventoryItem (item: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -224,7 +224,7 @@ async function createInventoryItem (item: {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -240,11 +240,11 @@ async function createInventoryItem (item: {
___
### createInventoryItems
#### createInventoryItems
This method is used to create inventory items.
#### Example
##### Example
```ts
import {
@@ -265,7 +265,7 @@ async function createInventoryItems (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -288,7 +288,7 @@ async function createInventoryItems (items: {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -304,11 +304,11 @@ async function createInventoryItems (items: {
___
### createInventoryLevel
#### createInventoryLevel
This method is used to create inventory level.
#### Example
##### Example
```ts
import {
@@ -330,7 +330,7 @@ async function createInventoryLevel (item: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -353,7 +353,7 @@ async function createInventoryLevel (item: {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -369,11 +369,11 @@ async function createInventoryLevel (item: {
___
### createInventoryLevels
#### createInventoryLevels
This method is used to create inventory levels.
#### Example
##### Example
```ts
import {
@@ -395,7 +395,7 @@ async function createInventoryLevels (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -418,7 +418,7 @@ async function createInventoryLevels (items: {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -434,11 +434,11 @@ async function createInventoryLevels (items: {
___
### createReservationItem
#### createReservationItem
This method is used to create a reservation item.
#### Example
##### Example
```ts
import {
@@ -460,7 +460,7 @@ async function createReservationItem (item: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -483,7 +483,7 @@ async function createReservationItem (item: {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -499,11 +499,11 @@ async function createReservationItem (item: {
___
### createReservationItems
#### createReservationItems
This method is used to create reservation items.
#### Example
##### Example
```ts
import {
@@ -525,7 +525,7 @@ async function createReservationItems (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -548,7 +548,7 @@ async function createReservationItems (items: {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -564,12 +564,12 @@ async function createReservationItems (items: {
___
### deleteInventoryItem
#### deleteInventoryItem
This method is used to delete an inventory item or multiple inventory items. The inventory items are only soft deleted and can be restored using the
[restoreInventoryItem](internal.internal-1.InventoryTypes.IInventoryService.mdx#restoreinventoryitem) method.
#### Example
##### Example
```ts
import {
@@ -587,7 +587,7 @@ async function deleteInventoryItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -610,7 +610,7 @@ async function deleteInventoryItem (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -626,11 +626,11 @@ async function deleteInventoryItem (
___
### deleteInventoryItemLevelByLocationId
#### deleteInventoryItemLevelByLocationId
This method deletes the inventory item level(s) for the ID(s) of associated location(s).
#### Example
##### Example
```ts
import {
@@ -648,7 +648,7 @@ async function deleteInventoryItemLevelByLocationId (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -671,7 +671,7 @@ async function deleteInventoryItemLevelByLocationId (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -687,11 +687,11 @@ async function deleteInventoryItemLevelByLocationId (
___
### deleteInventoryLevel
#### deleteInventoryLevel
This method is used to delete an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -711,7 +711,7 @@ async function deleteInventoryLevel (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -743,7 +743,7 @@ async function deleteInventoryLevel (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -759,11 +759,11 @@ async function deleteInventoryLevel (
___
### deleteReservationItem
#### deleteReservationItem
This method is used to delete a reservation item or multiple reservation items by their IDs.
#### Example
##### Example
```ts
import {
@@ -781,7 +781,7 @@ async function deleteReservationItems (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -804,7 +804,7 @@ async function deleteReservationItems (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -820,11 +820,11 @@ async function deleteReservationItems (
___
### deleteReservationItemByLocationId
#### deleteReservationItemByLocationId
This method deletes reservation item(s) by the ID(s) of associated location(s).
#### Example
##### Example
```ts
import {
@@ -842,7 +842,7 @@ async function deleteReservationItemByLocationId (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -865,7 +865,7 @@ async function deleteReservationItemByLocationId (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -881,11 +881,11 @@ async function deleteReservationItemByLocationId (
___
### deleteReservationItemsByLineItem
#### deleteReservationItemsByLineItem
This method is used to delete the reservation items associated with a line item or multiple line items.
#### Example
##### Example
```ts
import {
@@ -903,7 +903,7 @@ async function deleteReservationItemsByLineItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -926,7 +926,7 @@ async function deleteReservationItemsByLineItem (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -942,11 +942,11 @@ async function deleteReservationItemsByLineItem (
___
### listInventoryItems
#### listInventoryItems
This method is used to retrieve a paginated list of inventory items along with the total count of available inventory items satisfying the provided filters.
#### Example
##### Example
To retrieve a list of inventory items using their IDs:
@@ -1008,7 +1008,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1040,7 +1040,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1056,11 +1056,11 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
___
### listInventoryLevels
#### listInventoryLevels
This method is used to retrieve a paginated list of inventory levels along with the total count of available inventory levels satisfying the provided filters.
#### Example
##### Example
To retrieve a list of inventory levels using their IDs:
@@ -1122,7 +1122,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1154,7 +1154,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1170,11 +1170,11 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
___
### listReservationItems
#### listReservationItems
This method is used to retrieve a paginated list of reservation items along with the total count of available reservation items satisfying the provided filters.
#### Example
##### Example
To retrieve a list of reservation items using their IDs:
@@ -1236,7 +1236,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1268,7 +1268,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1284,11 +1284,11 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
___
### restoreInventoryItem
#### restoreInventoryItem
This method is used to restore an inventory item or multiple inventory items that were previously deleted using the [deleteInventoryItem](internal.internal-1.InventoryTypes.IInventoryService.mdx#deleteinventoryitem) method.
#### Example
##### Example
```ts
import {
@@ -1306,7 +1306,7 @@ async function restoreInventoryItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1329,7 +1329,7 @@ async function restoreInventoryItem (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1345,11 +1345,11 @@ async function restoreInventoryItem (
___
### retrieveAvailableQuantity
#### retrieveAvailableQuantity
This method is used to retrieve the available quantity of an inventory item within the specified locations.
#### Example
##### Example
```ts
import {
@@ -1371,7 +1371,7 @@ async function retrieveAvailableQuantity (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1403,7 +1403,7 @@ async function retrieveAvailableQuantity (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1419,11 +1419,11 @@ async function retrieveAvailableQuantity (
___
### retrieveInventoryItem
#### retrieveInventoryItem
This method is used to retrieve an inventory item by its ID
#### Example
##### Example
A simple example that retrieves a inventory item by its ID:
@@ -1459,7 +1459,7 @@ async function retrieveInventoryItem (id: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1491,7 +1491,7 @@ async function retrieveInventoryItem (id: string) {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1507,11 +1507,11 @@ async function retrieveInventoryItem (id: string) {
___
### retrieveInventoryLevel
#### retrieveInventoryLevel
This method is used to retrieve an inventory level for an inventory item and a location.
#### Example
##### Example
```ts
import {
@@ -1533,7 +1533,7 @@ async function retrieveInventoryLevel (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1565,7 +1565,7 @@ async function retrieveInventoryLevel (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1581,11 +1581,11 @@ async function retrieveInventoryLevel (
___
### retrieveReservationItem
#### retrieveReservationItem
This method is used to retrieve a reservation item by its ID.
#### Example
##### Example
```ts
import {
@@ -1601,7 +1601,7 @@ async function retrieveReservationItem (id: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1624,7 +1624,7 @@ async function retrieveReservationItem (id: string) {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1640,11 +1640,11 @@ async function retrieveReservationItem (id: string) {
___
### retrieveReservedQuantity
#### retrieveReservedQuantity
This method is used to retrieve the reserved quantity of an inventory item within the specified locations.
#### Example
##### Example
```ts
import {
@@ -1666,7 +1666,7 @@ async function retrieveReservedQuantity (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1698,7 +1698,7 @@ async function retrieveReservedQuantity (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1714,11 +1714,11 @@ async function retrieveReservedQuantity (
___
### retrieveStockedQuantity
#### retrieveStockedQuantity
This method is used to retrieve the stocked quantity of an inventory item within the specified locations.
#### Example
##### Example
```ts
import {
@@ -1740,7 +1740,7 @@ async function retrieveStockedQuantity (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1772,7 +1772,7 @@ async function retrieveStockedQuantity (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1788,11 +1788,11 @@ async function retrieveStockedQuantity (
___
### updateInventoryItem
#### updateInventoryItem
This method is used to update an inventory item.
#### Example
##### Example
```ts
import {
@@ -1816,7 +1816,7 @@ async function updateInventoryItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1848,7 +1848,7 @@ async function updateInventoryItem (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1864,11 +1864,11 @@ async function updateInventoryItem (
___
### updateInventoryLevel
#### updateInventoryLevel
This method is used to update an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -1894,7 +1894,7 @@ async function updateInventoryLevel (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1935,7 +1935,7 @@ async function updateInventoryLevel (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1951,11 +1951,11 @@ async function updateInventoryLevel (
___
### updateInventoryLevels
#### updateInventoryLevels
This method is used to update inventory levels. Each inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -1977,7 +1977,7 @@ async function updateInventoryLevels (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -2000,7 +2000,7 @@ async function updateInventoryLevels (items: {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -2016,11 +2016,11 @@ async function updateInventoryLevels (items: {
___
### updateReservationItem
#### updateReservationItem
This method is used to update a reservation item.
#### Example
##### Example
```ts
import {
@@ -2044,7 +2044,7 @@ async function updateReservationItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -2076,7 +2076,7 @@ async function updateReservationItem (
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.ReserveQuantityContext.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ReserveQuantityContext
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/js-client/ModulesSdkTypes/enums/internal.internal-1.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx
View File

@@ -8,8 +8,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### ISOLATED
#### ISOLATED
___
### SHARED
#### SHARED

4
www/apps/docs/content/references/js-client/ModulesSdkTypes/enums/internal.internal-1.ModulesSdkTypes.MODULE_SCOPE.mdx
View File

@@ -8,8 +8,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### EXTERNAL
#### EXTERNAL
___
### INTERNAL
#### INTERNAL

4
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.Constructor.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Constructor
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
### Type declaration
#### Type declaration
##### Parameters

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ExternalModuleDeclaration
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.InternalModuleDeclaration.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# InternalModuleDeclaration
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.LinkModuleDefinition.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# LinkModuleDefinition
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

4
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.LoaderOptions.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# LoaderOptions
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleDefinition.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleDefinition
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleExports.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleExports
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleLoaderFunction.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleLoaderFunction
### Type declaration
#### Type declaration
##### Parameters

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleResolution
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleServiceInitializeCustomDataLayerOptions
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{

2
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.RemoteQueryFunction.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# RemoteQueryFunction
### Type declaration
#### Type declaration
##### Parameters

75
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx Normal file
View File

@@ -0,0 +1,75 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListDTO
## Properties
<ParameterTypes parameters={[
{
"name": "customer_groups",
"type": "``{ id: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ends_at",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "number_rules",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "prices",
"type": "``{ amount: number ; currency_code: string ; max_quantity?: number ; min_quantity?: number ; region_id?: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rules",
"type": "[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "starts_at",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[PriceListStatus](../../PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

66
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx Normal file
View File

@@ -0,0 +1,66 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListPriceDTO
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency_code",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "max_quantity",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "min_quantity",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_id",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "region_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

30
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx Normal file
View File

@@ -0,0 +1,30 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListRuleDTO
## Properties
<ParameterTypes parameters={[
{
"name": "rule_attribute",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

102
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx Normal file
View File

@@ -0,0 +1,102 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListWorkflowDTO
## Properties
<ParameterTypes parameters={[
{
"name": "description",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ends_at",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "number_rules",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "prices",
"type": "[InputPrice](../../internal/interfaces/internal.InputPrice.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rules",
"type": "[CreatePriceListRules](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "starts_at",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[PriceListStatus](../../PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

21
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx Normal file
View File

@@ -0,0 +1,21 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListWorkflowInputDTO
## Properties
<ParameterTypes parameters={[
{
"name": "price_lists",
"type": "[CreatePriceListWorkflowDTO](internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

30
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx Normal file
View File

@@ -0,0 +1,30 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# RemovePriceListPricesWorkflowInputDTO
## Properties
<ParameterTypes parameters={[
{
"name": "money_amount_ids",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

Some files were not shown because too many files have changed in this diff Show More