asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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
co-authored by Oli Juhl Shahed Nasser
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
packages/types/src/product/service.ts
+73 -1
View File
@@ -1491,11 +1491,57 @@ export interface IProductModuleService {
sharedContext?: Context sharedContext?: Context
): Promise<ProductVariantDTO[]> ): Promise<ProductVariantDTO[]>
/**
* This method is used to update a product's variants.
*
* @param {UpdateProductVariantDTO[]} data - The product variants to update.
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<ProductVariantDTO[]>} The updated product variants's details.
*
* @example
* import {
* initialize as initializeProductModule,
* } from "@medusajs/product"
* import {
* UpdateProductVariantDTO
* } from "@medusajs/product/dist/types/services/product-variant"
*
* async function updateProductVariants (items: UpdateProductVariantDTO[]) {
* const productModule = await initializeProductModule()
*
* const productVariants = await productModule.updateVariants(items)
*
* // do something with the product variants or return them
* }
*/
updateVariants( updateVariants(
data: UpdateProductVariantDTO[], data: UpdateProductVariantDTO[],
sharedContext?: Context sharedContext?: Context
): Promise<ProductVariantDTO[]> ): Promise<ProductVariantDTO[]>
/**
* This method is used to create variants for a product.
*
* @param {CreateProductVariantDTO[]} data - The product variants to create.
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<ProductVariantDTO[]>} The created product variants' details.
*
* @example
* import {
* initialize as initializeProductModule,
* } from "@medusajs/product"
*
* async function createProductVariants (items: {
* product_id: string,
* title: string
* }[]) {
* const productModule = await initializeProductModule()
*
* const productVariants = await productModule.createVariants(items)
*
* // do something with the product variants or return them
* }
*/
createVariants( createVariants(
data: CreateProductVariantDTO[], data: CreateProductVariantDTO[],
sharedContext?: Context sharedContext?: Context
@@ -2437,7 +2483,7 @@ export interface IProductModuleService {
* *
* @param {string[]} productIds - The IDs of the products to restore. * @param {string[]} productIds - The IDs of the products to restore.
* @param {RestoreReturn<TReturnableLinkableKeys>} config - * @param {RestoreReturn<TReturnableLinkableKeys>} config -
* Configurations determining which relations to restore along with the each of the products. You can pass to its `returnLinkableKeys` * Configurations determining which relations to restore along with each of the products. You can pass to its `returnLinkableKeys`
* property any of the product's relation attribute names, such as `variant_id`. * property any of the product's relation attribute names, such as `variant_id`.
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module. * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<Record<string, string[]> | void>} * @returns {Promise<Record<string, string[]> | void>}
@@ -2466,6 +2512,32 @@ export interface IProductModuleService {
sharedContext?: Context sharedContext?: Context
): Promise<Record<string, string[]> | void> ): Promise<Record<string, string[]> | void>
/**
* This method is used to restore product varaints that were soft deleted. Product variants are soft deleted when they're not
* provided in a product's details passed to the {@link update} method.
*
* @param {string[]} variantIds - The IDs of the variants to restore.
* @param {RestoreReturn<TReturnableLinkableKeys>} config -
* Configurations determining which relations to restore along with each of the product variants. You can pass to its `returnLinkableKeys`
* property any of the product variant's relation attribute names.
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<Record<string, string[]> | void>}
* An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the product variant entity's relations
* and its value is an array of strings, each being the ID of the record associated with the product variant through this relation.
*
* If there are no related records that were restored, the promise resolved to `void`.
*
* @example
* import {
* initialize as initializeProductModule,
* } from "@medusajs/product"
*
* async function restoreProductVariants (ids: string[]) {
* const productModule = await initializeProductModule()
*
* await productModule.restoreVariants(ids)
* }
*/
restoreVariants<TReturnableLinkableKeys extends string = string>( restoreVariants<TReturnableLinkableKeys extends string = string>(
variantIds: string[], variantIds: string[],
config?: RestoreReturn<TReturnableLinkableKeys>, config?: RestoreReturn<TReturnableLinkableKeys>,
www/apps/docs/content/references/entities/classes/MoneyAmount.mdx
+1 -1
View File
@@ -332,7 +332,7 @@ A Money Amount represent a price amount, for example, a product variant's price
}, },
{ {
"name": "region_id", "name": "region_id",
"type": "`string`", "type": "`null` \\| `string`",
"description": "The region's ID", "description": "The region's ID",
"optional": false, "optional": false,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/entities/classes/PriceList.mdx
+1 -1
View File
@@ -266,7 +266,7 @@ A Price List represents a set of prices that override the default price for one
}, },
{ {
"name": "region_id", "name": "region_id",
"type": "`string`", "type": "`null` \\| `string`",
"description": "The region's ID", "description": "The region's ID",
"optional": false, "optional": false,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductVariant.mdx
+1 -1
View File
@@ -437,7 +437,7 @@ A Product Variant represents a Product with a specific set of Product Option con
}, },
{ {
"name": "region_id", "name": "region_id",
"type": "`string`", "type": "`null` \\| `string`",
"description": "The region's ID", "description": "The region's ID",
"optional": false, "optional": false,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/entities/enums/AllocationType.mdx
+2 -2
View File
@@ -10,7 +10,7 @@ The scope that the discount should apply to.
## Enumeration Members ## Enumeration Members
### ITEM #### ITEM
**ITEM** = `"item"` **ITEM** = `"item"`
@@ -18,7 +18,7 @@ The discount should be applied to applicable items in the cart.
___ ___
### TOTAL #### TOTAL
**TOTAL** = `"total"` **TOTAL** = `"total"`
www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx
+7 -7
View File
@@ -8,42 +8,42 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
___ ___
### COMPLETED #### COMPLETED
**COMPLETED** = `"completed"` **COMPLETED** = `"completed"`
___ ___
### CONFIRMED #### CONFIRMED
**CONFIRMED** = `"confirmed"` **CONFIRMED** = `"confirmed"`
___ ___
### CREATED #### CREATED
**CREATED** = `"created"` **CREATED** = `"created"`
___ ___
### FAILED #### FAILED
**FAILED** = `"failed"` **FAILED** = `"failed"`
___ ___
### PRE\_PROCESSED #### PRE\_PROCESSED
**PRE\_PROCESSED** = `"pre_processed"` **PRE\_PROCESSED** = `"pre_processed"`
___ ___
### PROCESSING #### PROCESSING
**PROCESSING** = `"processing"` **PROCESSING** = `"processing"`
www/apps/docs/content/references/entities/enums/CartType.mdx
+5 -5
View File
@@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### CLAIM #### CLAIM
**CLAIM** = `"claim"` **CLAIM** = `"claim"`
___ ___
### DEFAULT #### DEFAULT
**DEFAULT** = `"default"` **DEFAULT** = `"default"`
___ ___
### DRAFT\_ORDER #### DRAFT\_ORDER
**DRAFT\_ORDER** = `"draft_order"` **DRAFT\_ORDER** = `"draft_order"`
___ ___
### PAYMENT\_LINK #### PAYMENT\_LINK
**PAYMENT\_LINK** = `"payment_link"` **PAYMENT\_LINK** = `"payment_link"`
___ ___
### SWAP #### SWAP
**SWAP** = `"swap"` **SWAP** = `"swap"`
www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx
+9 -9
View File
@@ -10,7 +10,7 @@ The claim's fulfillment status.
## Enumeration Members ## Enumeration Members
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The claim's fulfillments are canceled.
___ ___
### FULFILLED #### FULFILLED
**FULFILLED** = `"fulfilled"` **FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The claim's replacement items are fulfilled.
___ ___
### NOT\_FULFILLED #### NOT\_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"` **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"` **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"` **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"` **REQUIRES\_ACTION** = `"requires_action"`
@@ -66,7 +66,7 @@ The claim's fulfillment requires action.
___ ___
### RETURNED #### RETURNED
**RETURNED** = `"returned"` **RETURNED** = `"returned"`
@@ -74,7 +74,7 @@ The claim's items are returned.
___ ___
### SHIPPED #### SHIPPED
**SHIPPED** = `"shipped"` **SHIPPED** = `"shipped"`
www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx
+3 -3
View File
@@ -10,7 +10,7 @@ The claim's payment status
## Enumeration Members ## Enumeration Members
### NA #### NA
**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"` **NOT\_REFUNDED** = `"not_refunded"`
@@ -26,7 +26,7 @@ The payment isn't refunded.
___ ___
### REFUNDED #### REFUNDED
**REFUNDED** = `"refunded"` **REFUNDED** = `"refunded"`
www/apps/docs/content/references/entities/enums/ClaimReason.mdx
+4 -4
View File
@@ -8,24 +8,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### MISSING\_ITEM #### MISSING\_ITEM
**MISSING\_ITEM** = `"missing_item"` **MISSING\_ITEM** = `"missing_item"`
___ ___
### OTHER #### OTHER
**OTHER** = `"other"` **OTHER** = `"other"`
___ ___
### PRODUCTION\_FAILURE #### PRODUCTION\_FAILURE
**PRODUCTION\_FAILURE** = `"production_failure"` **PRODUCTION\_FAILURE** = `"production_failure"`
___ ___
### WRONG\_ITEM #### WRONG\_ITEM
**WRONG\_ITEM** = `"wrong_item"` **WRONG\_ITEM** = `"wrong_item"`
www/apps/docs/content/references/entities/enums/ClaimType.mdx
+2 -2
View File
@@ -10,7 +10,7 @@ The claim's type.
## Enumeration Members ## Enumeration Members
### REFUND #### REFUND
**REFUND** = `"refund"` **REFUND** = `"refund"`
@@ -18,7 +18,7 @@ The claim refunds an amount to the customer.
___ ___
### REPLACE #### REPLACE
**REPLACE** = `"replace"` **REPLACE** = `"replace"`
www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx
+2 -2
View File
@@ -10,7 +10,7 @@ The possible operators used for a discount condition.
## Enumeration Members ## Enumeration Members
### IN #### IN
**IN** = `"in"` **IN** = `"in"`
@@ -18,7 +18,7 @@ The discountable resources are within the specified resources.
___ ___
### NOT\_IN #### NOT\_IN
**NOT\_IN** = `"not_in"` **NOT\_IN** = `"not_in"`
www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx
+5 -5
View File
@@ -10,7 +10,7 @@ The discount condition's type.
## Enumeration Members ## Enumeration Members
### CUSTOMER\_GROUPS #### CUSTOMER\_GROUPS
**CUSTOMER\_GROUPS** = `"customer_groups"` **CUSTOMER\_GROUPS** = `"customer_groups"`
@@ -18,7 +18,7 @@ The discount condition is used for customer groups.
___ ___
### PRODUCTS #### PRODUCTS
**PRODUCTS** = `"products"` **PRODUCTS** = `"products"`
@@ -26,7 +26,7 @@ The discount condition is used for products.
___ ___
### PRODUCT\_COLLECTIONS #### PRODUCT\_COLLECTIONS
**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"` **PRODUCT\_TAGS** = `"product_tags"`
@@ -42,7 +42,7 @@ The discount condition is used for product tags.
___ ___
### PRODUCT\_TYPES #### PRODUCT\_TYPES
**PRODUCT\_TYPES** = `"product_types"` **PRODUCT\_TYPES** = `"product_types"`
www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx
+3 -3
View File
@@ -10,7 +10,7 @@ The possible types of discount rules.
## Enumeration Members ## Enumeration Members
### FIXED #### FIXED
**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"` **FREE\_SHIPPING** = `"free_shipping"`
@@ -26,7 +26,7 @@ Discounts that sets the shipping price to `0`.
___ ___
### PERCENTAGE #### PERCENTAGE
**PERCENTAGE** = `"percentage"` **PERCENTAGE** = `"percentage"`
www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx
+2 -2
View File
@@ -10,7 +10,7 @@ The draft order's status.
## Enumeration Members ## Enumeration Members
### COMPLETED #### COMPLETED
**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"` **OPEN** = `"open"`
www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx
+9 -9
View File
@@ -10,7 +10,7 @@ The order's fulfillment status.
## Enumeration Members ## Enumeration Members
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The order's fulfillments are canceled.
___ ___
### FULFILLED #### FULFILLED
**FULFILLED** = `"fulfilled"` **FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The order's items are fulfilled.
___ ___
### NOT\_FULFILLED #### NOT\_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"` **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"` **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"` **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"` **REQUIRES\_ACTION** = `"requires_action"`
@@ -66,7 +66,7 @@ The order's fulfillment requires action.
___ ___
### RETURNED #### RETURNED
**RETURNED** = `"returned"` **RETURNED** = `"returned"`
@@ -74,7 +74,7 @@ The order's items are returned.
___ ___
### SHIPPED #### SHIPPED
**SHIPPED** = `"shipped"` **SHIPPED** = `"shipped"`
www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx
+3 -3
View File
@@ -10,7 +10,7 @@ The type of the order edit item change.
## Enumeration Members ## Enumeration Members
### ITEM\_ADD #### ITEM\_ADD
**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"` **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"` **ITEM\_UPDATE** = `"item_update"`
www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx
+5 -5
View File
@@ -10,7 +10,7 @@ The order edit's status.
## Enumeration Members ## Enumeration Members
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The order edit is canceled.
___ ___
### CONFIRMED #### CONFIRMED
**CONFIRMED** = `"confirmed"` **CONFIRMED** = `"confirmed"`
@@ -26,7 +26,7 @@ The order edit is confirmed.
___ ___
### CREATED #### CREATED
**CREATED** = `"created"` **CREATED** = `"created"`
@@ -34,7 +34,7 @@ The order edit is created.
___ ___
### DECLINED #### DECLINED
**DECLINED** = `"declined"` **DECLINED** = `"declined"`
@@ -42,7 +42,7 @@ The order edit is declined.
___ ___
### REQUESTED #### REQUESTED
**REQUESTED** = `"requested"` **REQUESTED** = `"requested"`
www/apps/docs/content/references/entities/enums/OrderStatus.mdx
+5 -5
View File
@@ -10,7 +10,7 @@ The order's status.
## Enumeration Members ## Enumeration Members
### ARCHIVED #### ARCHIVED
**ARCHIVED** = `"archived"` **ARCHIVED** = `"archived"`
@@ -18,7 +18,7 @@ The order is archived.
___ ___
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The order is canceled.
___ ___
### COMPLETED #### COMPLETED
**COMPLETED** = `"completed"` **COMPLETED** = `"completed"`
@@ -36,7 +36,7 @@ has been captured.
___ ___
### PENDING #### PENDING
**PENDING** = `"pending"` **PENDING** = `"pending"`
@@ -44,7 +44,7 @@ The order is pending.
___ ___
### REQUIRES\_ACTION #### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"` **REQUIRES\_ACTION** = `"requires_action"`
www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx
+5 -5
View File
@@ -10,7 +10,7 @@ The payment collection's status.
## Enumeration Members ## Enumeration Members
### AUTHORIZED #### AUTHORIZED
**AUTHORIZED** = `"authorized"` **AUTHORIZED** = `"authorized"`
@@ -18,7 +18,7 @@ The payment colleciton is authorized.
___ ___
### AWAITING #### AWAITING
**AWAITING** = `"awaiting"` **AWAITING** = `"awaiting"`
@@ -26,7 +26,7 @@ The payment collection is awaiting payment.
___ ___
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -34,7 +34,7 @@ The payment collection is canceled.
___ ___
### NOT\_PAID #### NOT\_PAID
**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"` **PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx
+1 -1
View File
@@ -10,7 +10,7 @@ The payment collection's type.
## Enumeration Members ## Enumeration Members
### ORDER\_EDIT #### ORDER\_EDIT
**ORDER\_EDIT** = `"order_edit"` **ORDER\_EDIT** = `"order_edit"`
www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx
+5 -5
View File
@@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### AUTHORIZED #### AUTHORIZED
**AUTHORIZED** = `"authorized"` **AUTHORIZED** = `"authorized"`
___ ___
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
___ ___
### ERROR #### ERROR
**ERROR** = `"error"` **ERROR** = `"error"`
___ ___
### PENDING #### PENDING
**PENDING** = `"pending"` **PENDING** = `"pending"`
___ ___
### REQUIRES\_MORE #### REQUIRES\_MORE
**REQUIRES\_MORE** = `"requires_more"` **REQUIRES\_MORE** = `"requires_more"`
www/apps/docs/content/references/entities/enums/PaymentStatus.mdx
+7 -7
View File
@@ -10,7 +10,7 @@ The order's payment status.
## Enumeration Members ## Enumeration Members
### AWAITING #### AWAITING
**AWAITING** = `"awaiting"` **AWAITING** = `"awaiting"`
@@ -18,7 +18,7 @@ The order's payment is awaiting capturing.
___ ___
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The order's payment is canceled.
___ ___
### CAPTURED #### CAPTURED
**CAPTURED** = `"captured"` **CAPTURED** = `"captured"`
@@ -34,7 +34,7 @@ The order's payment is captured.
___ ___
### NOT\_PAID #### NOT\_PAID
**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"` **PARTIALLY\_REFUNDED** = `"partially_refunded"`
@@ -50,7 +50,7 @@ Some of the order's payment amount is refunded.
___ ___
### REFUNDED #### REFUNDED
**REFUNDED** = `"refunded"` **REFUNDED** = `"refunded"`
@@ -58,7 +58,7 @@ The order's payment amount is refunded.
___ ___
### REQUIRES\_ACTION #### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"` **REQUIRES\_ACTION** = `"requires_action"`
www/apps/docs/content/references/entities/enums/PriceListStatus.mdx
+2 -2
View File
@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### ACTIVE #### ACTIVE
**ACTIVE** = `"active"` **ACTIVE** = `"active"`
___ ___
### DRAFT #### DRAFT
**DRAFT** = `"draft"` **DRAFT** = `"draft"`
www/apps/docs/content/references/entities/enums/PriceListType.mdx
+2 -2
View File
@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### OVERRIDE #### OVERRIDE
**OVERRIDE** = `"override"` **OVERRIDE** = `"override"`
___ ___
### SALE #### SALE
**SALE** = `"sale"` **SALE** = `"sale"`
www/apps/docs/content/references/entities/enums/ProductStatus.mdx
+4 -4
View File
@@ -10,7 +10,7 @@ The status of a product.
## Enumeration Members ## Enumeration Members
### DRAFT #### DRAFT
**DRAFT** = `"draft"` **DRAFT** = `"draft"`
@@ -18,7 +18,7 @@ The product is a draft. It's not viewable by customers.
___ ___
### PROPOSED #### PROPOSED
**PROPOSED** = `"proposed"` **PROPOSED** = `"proposed"`
@@ -26,7 +26,7 @@ The product is proposed, but not yet published.
___ ___
### PUBLISHED #### PUBLISHED
**PUBLISHED** = `"published"` **PUBLISHED** = `"published"`
@@ -34,7 +34,7 @@ The product is published.
___ ___
### REJECTED #### REJECTED
**REJECTED** = `"rejected"` **REJECTED** = `"rejected"`
www/apps/docs/content/references/entities/enums/RefundReason.mdx
+5 -5
View File
@@ -10,7 +10,7 @@ The reason of the refund.
## Enumeration Members ## Enumeration Members
### CLAIM #### CLAIM
**CLAIM** = `"claim"` **CLAIM** = `"claim"`
@@ -18,7 +18,7 @@ The refund is applied because of a created claim.
___ ___
### DISCOUNT #### DISCOUNT
**DISCOUNT** = `"discount"` **DISCOUNT** = `"discount"`
@@ -26,7 +26,7 @@ The refund is applied as a discount.
___ ___
### OTHER #### OTHER
**OTHER** = `"other"` **OTHER** = `"other"`
@@ -34,7 +34,7 @@ The refund is created for a custom reason.
___ ___
### RETURN #### RETURN
**RETURN** = `"return"` **RETURN** = `"return"`
@@ -42,7 +42,7 @@ The refund is applied because of a created return.
___ ___
### SWAP #### SWAP
**SWAP** = `"swap"` **SWAP** = `"swap"`
www/apps/docs/content/references/entities/enums/RequirementType.mdx
+2 -2
View File
@@ -10,7 +10,7 @@ The type of shipping option requirement.
## Enumeration Members ## Enumeration Members
### MAX\_SUBTOTAL #### MAX\_SUBTOTAL
**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"` **MIN\_SUBTOTAL** = `"min_subtotal"`
www/apps/docs/content/references/entities/enums/ReturnStatus.mdx
+4 -4
View File
@@ -10,7 +10,7 @@ The return's status.
## Enumeration Members ## Enumeration Members
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The return is canceled.
___ ___
### RECEIVED #### RECEIVED
**RECEIVED** = `"received"` **RECEIVED** = `"received"`
@@ -26,7 +26,7 @@ The return is received.
___ ___
### REQUESTED #### REQUESTED
**REQUESTED** = `"requested"` **REQUESTED** = `"requested"`
@@ -34,7 +34,7 @@ The return is requested.
___ ___
### REQUIRES\_ACTION #### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"` **REQUIRES\_ACTION** = `"requires_action"`
www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx
+2 -2
View File
@@ -10,7 +10,7 @@ The type of the shipping option price.
## Enumeration Members ## Enumeration Members
### CALCULATED #### CALCULATED
**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"` **FLAT\_RATE** = `"flat_rate"`
www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx
+3 -3
View File
@@ -10,7 +10,7 @@ The shipping profile's type.
## Enumeration Members ## Enumeration Members
### CUSTOM #### CUSTOM
**CUSTOM** = `"custom"` **CUSTOM** = `"custom"`
@@ -18,7 +18,7 @@ The profile used to ship custom items.
___ ___
### DEFAULT #### DEFAULT
**DEFAULT** = `"default"` **DEFAULT** = `"default"`
@@ -26,7 +26,7 @@ The default profile used to ship item.
___ ___
### GIFT\_CARD #### GIFT\_CARD
**GIFT\_CARD** = `"gift_card"` **GIFT\_CARD** = `"gift_card"`
www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx
+6 -6
View File
@@ -10,7 +10,7 @@ The swap's fulfillment status.
## Enumeration Members ## Enumeration Members
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The swap's fulfillments are canceled.
___ ___
### FULFILLED #### FULFILLED
**FULFILLED** = `"fulfilled"` **FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The swap's items are fulfilled.
___ ___
### NOT\_FULFILLED #### NOT\_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"` **PARTIALLY\_SHIPPED** = `"partially_shipped"`
@@ -42,7 +42,7 @@ Some of the swap's items are shipped.
___ ___
### REQUIRES\_ACTION #### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"` **REQUIRES\_ACTION** = `"requires_action"`
@@ -50,7 +50,7 @@ The swap's fulfillments require an action.
___ ___
### SHIPPED #### SHIPPED
**SHIPPED** = `"shipped"` **SHIPPED** = `"shipped"`
www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx
+9 -9
View File
@@ -10,7 +10,7 @@ The swap's payment status.
## Enumeration Members ## Enumeration Members
### AWAITING #### AWAITING
**AWAITING** = `"awaiting"` **AWAITING** = `"awaiting"`
@@ -18,7 +18,7 @@ The swap is additional awaiting payment.
___ ___
### CANCELED #### CANCELED
**CANCELED** = `"canceled"` **CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The swap's additional payment is canceled.
___ ___
### CAPTURED #### CAPTURED
**CAPTURED** = `"captured"` **CAPTURED** = `"captured"`
@@ -34,7 +34,7 @@ The swap's additional payment is captured.
___ ___
### CONFIRMED #### CONFIRMED
**CONFIRMED** = `"confirmed"` **CONFIRMED** = `"confirmed"`
@@ -42,7 +42,7 @@ The swap's additional payment is confirmed.
___ ___
### DIFFERENCE\_REFUNDED #### DIFFERENCE\_REFUNDED
**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"` **NOT\_PAID** = `"not_paid"`
@@ -58,7 +58,7 @@ The swap's additional payment isn't paid.
___ ___
### PARTIALLY\_REFUNDED #### PARTIALLY\_REFUNDED
**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"` **REFUNDED** = `"refunded"`
@@ -74,7 +74,7 @@ The amount in the associated order has been refunded.
___ ___
### REQUIRES\_ACTION #### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"` **REQUIRES\_ACTION** = `"requires_action"`
www/apps/docs/content/references/entities/enums/UserRoles.mdx
+3 -3
View File
@@ -10,7 +10,7 @@ The user's role. These roles don't change the user's capabilities or provide acc
## Enumeration Members ## Enumeration Members
### ADMIN #### ADMIN
**ADMIN** = `"admin"` **ADMIN** = `"admin"`
@@ -18,7 +18,7 @@ The user is an admin.
___ ___
### DEVELOPER #### DEVELOPER
**DEVELOPER** = `"developer"` **DEVELOPER** = `"developer"`
@@ -26,7 +26,7 @@ The user is a developer.
___ ___
### MEMBER #### MEMBER
**MEMBER** = `"member"` **MEMBER** = `"member"`
www/apps/docs/content/references/entities/index.mdx
+5 -3
View File
@@ -137,10 +137,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Functions ## Functions
### Boolean #### Boolean
`**Boolean**<TypeParameter T>(value?): boolean` `**Boolean**<TypeParameter T>(value?): boolean`
##### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
"name": "T", "name": "T",
@@ -153,7 +155,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -167,7 +169,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
#### Returns ##### Returns
`boolean` `boolean`
www/apps/docs/content/references/entities/types/BatchJobResultError.mdx
+2 -2
View File
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**BatchJobResultError**: `Object` **BatchJobResultError**: `Object`
### Index signature #### Index signature
▪ [key: `string`]: `unknown` ▪ [key: `string`]: `unknown`
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/entities/types/BatchJobResultStatDescriptor.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**BatchJobResultStatDescriptor**: `Object` **BatchJobResultStatDescriptor**: `Object`
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/entities/types/Record.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Record # 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 Construct a type with a set of properties K of type T
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listInventoryItems.mdx
+3 -13
View File
@@ -165,17 +165,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
"expandable": false, "expandable": false,
"children": [ "children": []
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}, },
{ {
"name": "relations", "name": "relations",
@@ -197,7 +187,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
}, },
{ {
"name": "skip", "name": "skip",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.", "description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
@@ -206,7 +196,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
}, },
{ {
"name": "take", "name": "take",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.", "description": "A number indicating the number of records to return in the result.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listInventoryLevels.mdx
+3 -13
View File
@@ -147,17 +147,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
"expandable": false, "expandable": false,
"children": [ "children": []
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}, },
{ {
"name": "relations", "name": "relations",
@@ -179,7 +169,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
}, },
{ {
"name": "skip", "name": "skip",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.", "description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
@@ -188,7 +178,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
}, },
{ {
"name": "take", "name": "take",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.", "description": "A number indicating the number of records to return in the result.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listReservationItems.mdx
+3 -13
View File
@@ -165,17 +165,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
"expandable": false, "expandable": false,
"children": [ "children": []
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}, },
{ {
"name": "relations", "name": "relations",
@@ -197,7 +187,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
}, },
{ {
"name": "skip", "name": "skip",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.", "description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
@@ -206,7 +196,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
}, },
{ {
"name": "take", "name": "take",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.", "description": "A number indicating the number of records to return in the result.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx
+3 -13
View File
@@ -75,17 +75,7 @@ async function retrieveInventoryItem (id: string) {
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
"expandable": false, "expandable": false,
"children": [ "children": []
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}, },
{ {
"name": "relations", "name": "relations",
@@ -107,7 +97,7 @@ async function retrieveInventoryItem (id: string) {
}, },
{ {
"name": "skip", "name": "skip",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.", "description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
@@ -116,7 +106,7 @@ async function retrieveInventoryItem (id: string) {
}, },
{ {
"name": "take", "name": "take",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.", "description": "A number indicating the number of records to return in the result.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/inventory/interfaces/FindConfig.mdx
+3 -13
View File
@@ -33,17 +33,7 @@ which provides correct typing of field names in its properties.
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
"expandable": false, "expandable": false,
"children": [ "children": []
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}, },
{ {
"name": "relations", "name": "relations",
@@ -65,7 +55,7 @@ which provides correct typing of field names in its properties.
}, },
{ {
"name": "skip", "name": "skip",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.", "description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
@@ -74,7 +64,7 @@ which provides correct typing of field names in its properties.
}, },
{ {
"name": "take", "name": "take",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.", "description": "A number indicating the number of records to return in the result.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/inventory/types/Exclude.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Exclude # 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 Exclude from T those types that are assignable to U
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**InventoryItemDTO**: `Object` **InventoryItemDTO**: `Object`
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**InventoryLevelDTO**: `Object` **InventoryLevelDTO**: `Object`
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/JoinerRelationship.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**JoinerRelationship**: `Object` **JoinerRelationship**: `Object`
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/Omit.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Omit # 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. Construct a type with the properties of T except for those in type K.
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/Partial.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Partial # 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 Make all properties in T optional
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/Pick.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Pick # 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 From T, pick a set of properties whose keys are in the union K
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/Record.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Record # 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 Construct a type with a set of properties K of type T
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx
+1 -1
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Represents a reservation of an inventory item at a stock location Represents a reservation of an inventory item at a stock location
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx
+9 -9
View File
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods ## Methods
### get #### get
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -40,9 +40,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___ ___
### invalidate #### invalidate
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -56,7 +56,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -72,9 +72,9 @@ ___
___ ___
### set #### set
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -106,7 +106,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx
+2 -2
View File
@@ -55,7 +55,7 @@ which provides correct typing of field names in its properties.
}, },
{ {
"name": "skip", "name": "skip",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.", "description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
@@ -64,7 +64,7 @@ which provides correct typing of field names in its properties.
}, },
{ {
"name": "take", "name": "take",
"type": "`number`", "type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.", "description": "A number indicating the number of records to return in the result.",
"optional": true, "optional": true,
"defaultValue": "", "defaultValue": "",
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ConfigModule # ConfigModule
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ExtendedFindConfig.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ExtendedFindConfig # ExtendedFindConfig
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.HttpCompressionOptions.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# HttpCompressionOptions # HttpCompressionOptions
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.PartialPick.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# PartialPick # PartialPick
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ProjectConfigOptions # ProjectConfigOptions
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.QueryConfig.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# QueryConfig # QueryConfig
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.QuerySelector.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# QuerySelector # QuerySelector
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.RequestQueryFields.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# RequestQueryFields # RequestQueryFields
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.Selector.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Selector # Selector
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.TreeQuerySelector.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# TreeQuerySelector # TreeQuerySelector
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.WithRequiredProperty.mdx
+1 -1
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 Utility type used to remove some optional attributes (coming from K) from a type T
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.Writable.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Writable # Writable
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/DAL/interfaces/internal.internal-1.DAL.RepositoryService.mdx
+53 -33
View File
@@ -26,9 +26,9 @@ ORM directly and allows to switch to another ORM without changing the business l
## Methods ## Methods
### create #### create
#### Parameters ##### Parameters
<ParameterTypes 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={[ <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={[ <ParameterTypes parameters={[
{ {
@@ -92,7 +92,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -108,9 +108,9 @@ ___
___ ___
### find #### find
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -133,7 +133,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -149,9 +149,9 @@ ___
___ ___
### findAndCount #### findAndCount
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -174,7 +174,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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={[ <ParameterTypes parameters={[
{ {
@@ -231,7 +251,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -247,9 +267,9 @@ ___
___ ___
### serialize #### serialize
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -272,7 +292,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -288,11 +308,11 @@ ___
___ ___
### softDelete #### softDelete
Soft delete entities and cascade to related entities if configured. Soft delete entities and cascade to related entities if configured.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -315,7 +335,7 @@ Soft delete entities and cascade to related entities if configured.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -331,9 +351,9 @@ Soft delete entities and cascade to related entities if configured.
___ ___
### transaction #### transaction
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -383,7 +403,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -399,9 +419,9 @@ ___
___ ___
### update #### update
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -424,7 +444,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/DAL/interfaces/internal.internal-1.DAL.TreeRepositoryService.mdx
+44 -24
View File
@@ -26,9 +26,9 @@ ORM directly and allows to switch to another ORM without changing the business l
## Methods ## Methods
### create #### create
#### Parameters ##### Parameters
<ParameterTypes 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={[ <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={[ <ParameterTypes parameters={[
{ {
@@ -92,7 +92,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -108,9 +108,9 @@ ___
___ ___
### find #### find
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -142,7 +142,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -158,9 +158,9 @@ ___
___ ___
### findAndCount #### findAndCount
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -192,7 +192,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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={[ <ParameterTypes parameters={[
{ {
@@ -249,7 +269,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -265,9 +285,9 @@ ___
___ ___
### transaction #### transaction
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -317,7 +337,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/DAL/types/internal.internal-1.DAL.FilterQuery.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterQuery # FilterQuery
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/DAL/types/internal.internal-1.DAL.FindOptions.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FindOptions # FindOptions
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx
+11 -11
View File
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods ## Methods
### emit #### emit
`**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void&#62;` `**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void&#62;`
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -44,7 +44,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -60,7 +60,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**emit**<TypeParameter T>(data): Promise&#60;void&#62;` `**emit**<TypeParameter T>(data): Promise&#60;void&#62;`
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -90,9 +90,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___ ___
### subscribe #### subscribe
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -124,7 +124,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -140,9 +140,9 @@ ___
___ ___
### unsubscribe #### unsubscribe
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -174,7 +174,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx
+12 -12
View File
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods ## Methods
### emit #### emit
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -58,9 +58,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___ ___
### subscribe #### subscribe
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -92,7 +92,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -108,9 +108,9 @@ ___
___ ___
### unsubscribe #### unsubscribe
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -142,7 +142,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -158,9 +158,9 @@ ___
___ ___
### withTransaction #### withTransaction
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -174,7 +174,7 @@ ___
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# EmitData # EmitData
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.EventHandler.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# EventHandler # EventHandler
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
### Type declaration #### Type declaration
##### Parameters ##### Parameters
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Subscriber # Subscriber
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
### Type declaration #### Type declaration
##### Parameters ##### Parameters
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SubscriberContext # SubscriberContext
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberDescriptor.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SubscriberDescriptor # SubscriberDescriptor
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/EventEmitter/classes/internal.EventEmitter.EventEmitterAsyncResource.mdx
+71 -71
View File
@@ -91,9 +91,9 @@ v17.4.0, v16.14.0
## Methods ## Methods
### [captureRejectionSymbol] #### [captureRejectionSymbol]
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -125,7 +125,7 @@ v17.4.0, v16.14.0
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -141,11 +141,11 @@ v17.4.0, v16.14.0
___ ___
### addListener #### addListener
Alias for `emitter.on(eventName, listener)`. Alias for `emitter.on(eventName, listener)`.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -168,7 +168,7 @@ Alias for `emitter.on(eventName, listener)`.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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 Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each. 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 // event with parameters 1, 2, 3, 4, 5 in third listener
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -251,7 +251,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -271,14 +271,14 @@ v0.1.26
___ ___
### emitDestroy #### emitDestroy
Call all destroy hooks. This should only ever be called once. An 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 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 manually called. If the resource is left to be collected by the GC then
the destroy hooks will never be called. the destroy hooks will never be called.
#### Returns ##### Returns
<ParameterTypes parameters={[ <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 Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s. listeners. The values in the array are strings or `Symbol`s.
@@ -313,7 +313,7 @@ console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ] // Prints: [ 'foo', 'bar', Symbol(symbol) ]
``` ```
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -333,12 +333,12 @@ v6.0.0
___ ___
### getMaxListeners #### getMaxListeners
Returns the current max listener value for the `EventEmitter` which is either 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). set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal.EventEmitter.EventEmitterAsyncResource.mdx#defaultmaxlisteners).
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -358,13 +358,13 @@ v1.0.0
___ ___
### listenerCount #### listenerCount
Returns the number of listeners listening for the event named `eventName`. 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 If `listener` is provided, it will return how many times the listener is found
in the list of the listeners of the event. in the list of the listeners of the event.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -387,7 +387,7 @@ in the list of the listeners of the event.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -407,7 +407,7 @@ v3.2.0
___ ___
### listeners #### listeners
Returns a copy of the array of listeners for the event named `eventName`. 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] ] // Prints: [ [Function] ]
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -433,7 +433,7 @@ console.log(util.inspect(server.listeners('connection')));
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -453,11 +453,11 @@ v0.1.26
___ ___
### off #### off
Alias for `emitter.removeListener()`. Alias for `emitter.removeListener()`.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -480,7 +480,7 @@ Alias for `emitter.removeListener()`.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -500,7 +500,7 @@ v10.0.0
___ ___
### on #### on
Adds the `listener` function to the end of the listeners array for the 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 event named `eventName`. No checks are made to see if the `listener` has
@@ -529,7 +529,7 @@ myEE.emit('foo');
// a // a
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -552,7 +552,7 @@ myEE.emit('foo');
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -572,7 +572,7 @@ v0.1.101
___ ___
### once #### once
Adds a **one-time**`listener` function for the event named `eventName`. The Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked. next time `eventName` is triggered, this listener is removed and then invoked.
@@ -599,7 +599,7 @@ myEE.emit('foo');
// a // a
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -622,7 +622,7 @@ myEE.emit('foo');
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -642,7 +642,7 @@ v0.3.0
___ ___
### prependListener #### prependListener
Adds the `listener` function to the \_beginning\_ of the listeners array for the 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 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. Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -680,7 +680,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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 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. 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. Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -736,7 +736,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -756,7 +756,7 @@ v6.0.0
___ ___
### rawListeners #### rawListeners
Returns a copy of the array of listeners for the event named `eventName`, Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`). including any wrappers (such as those created by `.once()`).
@@ -786,7 +786,7 @@ newListeners[0]();
emitter.emit('log'); emitter.emit('log');
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -800,7 +800,7 @@ emitter.emit('log');
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -820,7 +820,7 @@ v9.4.0
___ ___
### removeAllListeners #### removeAllListeners
Removes all listeners, or those of the specified `eventName`. 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. Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -844,7 +844,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -864,7 +864,7 @@ v0.1.26
___ ___
### removeListener #### removeListener
Removes the specified `listener` from the listener array for the event named`eventName`. 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. Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -969,7 +969,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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 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 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. Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1012,7 +1012,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1032,7 +1032,7 @@ v0.3.5
___ ___
### addAbortListener #### addAbortListener
Listens once to the `abort` event on the provided `signal`. Listens once to the `abort` event on the provided `signal`.
@@ -1064,7 +1064,7 @@ function example(signal) {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1087,7 +1087,7 @@ function example(signal) {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1107,7 +1107,7 @@ v20.5.0
___ ___
### getEventListeners #### getEventListeners
Returns a copy of the array of listeners for the event named `eventName`. 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={[ <ParameterTypes parameters={[
{ {
@@ -1157,7 +1157,7 @@ import { getEventListeners, EventEmitter } from 'node:events';
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1177,7 +1177,7 @@ v15.2.0, v14.17.0
___ ___
### getMaxListeners #### getMaxListeners
Returns the currently set max amount of listeners. Returns the currently set max amount of listeners.
@@ -1205,7 +1205,7 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1219,7 +1219,7 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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`. 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 // Prints: 2
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1276,7 +1276,7 @@ console.log(listenerCount(myEmitter, 'event'));
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1300,7 +1300,7 @@ Since v3.2.0 - Use `listenerCount` instead.
___ ___
### on #### on
```js ```js
import { on, EventEmitter } from 'node:events'; import { on, EventEmitter } from 'node:events';
@@ -1357,7 +1357,7 @@ const ac = new AbortController();
process.nextTick(() => ac.abort()); process.nextTick(() => ac.abort());
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1389,7 +1389,7 @@ process.nextTick(() => ac.abort());
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1409,7 +1409,7 @@ v13.6.0, v12.16.0
___ ___
### once #### once
`Static **once**(emitter, eventName, options?): Promise&#60;any[]&#62;` `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! ee.emit('foo'); // Prints: Waiting for the event was canceled!
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1522,7 +1522,7 @@ ee.emit('foo'); // Prints: Waiting for the event was canceled!
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1542,7 +1542,7 @@ v11.13.0, v10.16.0
`Static **once**(emitter, eventName, options?): Promise&#60;any[]&#62;` `Static **once**(emitter, eventName, options?): Promise&#60;any[]&#62;`
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1574,7 +1574,7 @@ v11.13.0, v10.16.0
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1590,7 +1590,7 @@ v11.13.0, v10.16.0
___ ___
### setMaxListeners #### setMaxListeners
```js ```js
import { setMaxListeners, EventEmitter } from 'node:events'; import { setMaxListeners, EventEmitter } from 'node:events';
@@ -1601,7 +1601,7 @@ const emitter = new EventEmitter();
setMaxListeners(5, target, emitter); setMaxListeners(5, target, emitter);
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1624,7 +1624,7 @@ setMaxListeners(5, target, emitter);
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/EventEmitter/interfaces/internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx
+34 -14
View File
@@ -58,9 +58,9 @@ asyncResource.triggerAsyncId();
## Methods ## Methods
### asyncId #### asyncId
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -76,11 +76,11 @@ asyncResource.triggerAsyncId();
___ ___
### bind #### bind
Binds the given function to execute to this `AsyncResource`'s scope. Binds the given function to execute to this `AsyncResource`'s scope.
#### Parameters ##### Parameters
<ParameterTypes 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 #### 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 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 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 the resource is left to be collected by the GC then the `destroy` hooks will
never be called. never be called.
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -127,14 +137,14 @@ never be called.
___ ___
### runInAsyncScope #### runInAsyncScope
Call the provided function with the provided arguments in the execution context Call the provided function with the provided arguments in the execution context
of the async resource. This will establish the context, trigger the AsyncHooks of the async resource. This will establish the context, trigger the AsyncHooks
before callbacks, call the function, trigger the AsyncHooks after callbacks, and before callbacks, call the function, trigger the AsyncHooks after callbacks, and
then restore the original execution context. then restore the original execution context.
#### Parameters ##### Parameters
<ParameterTypes 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 #### Since
@@ -176,9 +196,9 @@ v9.6.0
___ ___
### triggerAsyncId #### triggerAsyncId
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/FeatureFlagTypes/types/internal.internal-1.FeatureFlagTypes.FlagSettings.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FlagSettings # FlagSettings
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx
+112 -112
View File
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods ## 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. 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 ```ts
import { import {
@@ -36,7 +36,7 @@ async function adjustInventory (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -77,7 +77,7 @@ async function adjustInventory (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. This method is used to confirm whether the specified quantity of an inventory item is available in the specified locations.
#### Example ##### Example
```ts ```ts
import { import {
@@ -119,7 +119,7 @@ async function confirmInventory (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -160,7 +160,7 @@ async function confirmInventory (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -176,11 +176,11 @@ async function confirmInventory (
___ ___
### createInventoryItem #### createInventoryItem
This method is used to create an inventory item. This method is used to create an inventory item.
#### Example ##### Example
```ts ```ts
import { import {
@@ -201,7 +201,7 @@ async function createInventoryItem (item: {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -224,7 +224,7 @@ async function createInventoryItem (item: {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -240,11 +240,11 @@ async function createInventoryItem (item: {
___ ___
### createInventoryItems #### createInventoryItems
This method is used to create inventory items. This method is used to create inventory items.
#### Example ##### Example
```ts ```ts
import { import {
@@ -265,7 +265,7 @@ async function createInventoryItems (items: {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -288,7 +288,7 @@ async function createInventoryItems (items: {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -304,11 +304,11 @@ async function createInventoryItems (items: {
___ ___
### createInventoryLevel #### createInventoryLevel
This method is used to create inventory level. This method is used to create inventory level.
#### Example ##### Example
```ts ```ts
import { import {
@@ -330,7 +330,7 @@ async function createInventoryLevel (item: {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -353,7 +353,7 @@ async function createInventoryLevel (item: {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -369,11 +369,11 @@ async function createInventoryLevel (item: {
___ ___
### createInventoryLevels #### createInventoryLevels
This method is used to create inventory levels. This method is used to create inventory levels.
#### Example ##### Example
```ts ```ts
import { import {
@@ -395,7 +395,7 @@ async function createInventoryLevels (items: {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -418,7 +418,7 @@ async function createInventoryLevels (items: {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -434,11 +434,11 @@ async function createInventoryLevels (items: {
___ ___
### createReservationItem #### createReservationItem
This method is used to create a reservation item. This method is used to create a reservation item.
#### Example ##### Example
```ts ```ts
import { import {
@@ -460,7 +460,7 @@ async function createReservationItem (item: {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -483,7 +483,7 @@ async function createReservationItem (item: {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -499,11 +499,11 @@ async function createReservationItem (item: {
___ ___
### createReservationItems #### createReservationItems
This method is used to create reservation items. This method is used to create reservation items.
#### Example ##### Example
```ts ```ts
import { import {
@@ -525,7 +525,7 @@ async function createReservationItems (items: {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -548,7 +548,7 @@ async function createReservationItems (items: {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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 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. [restoreInventoryItem](internal.internal-1.InventoryTypes.IInventoryService.mdx#restoreinventoryitem) method.
#### Example ##### Example
```ts ```ts
import { import {
@@ -587,7 +587,7 @@ async function deleteInventoryItem (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -610,7 +610,7 @@ async function deleteInventoryItem (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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). This method deletes the inventory item level(s) for the ID(s) of associated location(s).
#### Example ##### Example
```ts ```ts
import { import {
@@ -648,7 +648,7 @@ async function deleteInventoryItemLevelByLocationId (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -671,7 +671,7 @@ async function deleteInventoryItemLevelByLocationId (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. 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 ```ts
import { import {
@@ -711,7 +711,7 @@ async function deleteInventoryLevel (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -743,7 +743,7 @@ async function deleteInventoryLevel (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. This method is used to delete a reservation item or multiple reservation items by their IDs.
#### Example ##### Example
```ts ```ts
import { import {
@@ -781,7 +781,7 @@ async function deleteReservationItems (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -804,7 +804,7 @@ async function deleteReservationItems (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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). This method deletes reservation item(s) by the ID(s) of associated location(s).
#### Example ##### Example
```ts ```ts
import { import {
@@ -842,7 +842,7 @@ async function deleteReservationItemByLocationId (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -865,7 +865,7 @@ async function deleteReservationItemByLocationId (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. This method is used to delete the reservation items associated with a line item or multiple line items.
#### Example ##### Example
```ts ```ts
import { import {
@@ -903,7 +903,7 @@ async function deleteReservationItemsByLineItem (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -926,7 +926,7 @@ async function deleteReservationItemsByLineItem (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. 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: 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={[ <ParameterTypes parameters={[
{ {
@@ -1040,7 +1040,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. 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: 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={[ <ParameterTypes parameters={[
{ {
@@ -1154,7 +1154,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. 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: 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={[ <ParameterTypes parameters={[
{ {
@@ -1268,7 +1268,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. 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 ```ts
import { import {
@@ -1306,7 +1306,7 @@ async function restoreInventoryItem (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1329,7 +1329,7 @@ async function restoreInventoryItem (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. This method is used to retrieve the available quantity of an inventory item within the specified locations.
#### Example ##### Example
```ts ```ts
import { import {
@@ -1371,7 +1371,7 @@ async function retrieveAvailableQuantity (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1403,7 +1403,7 @@ async function retrieveAvailableQuantity (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1419,11 +1419,11 @@ async function retrieveAvailableQuantity (
___ ___
### retrieveInventoryItem #### retrieveInventoryItem
This method is used to retrieve an inventory item by its ID 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: A simple example that retrieves a inventory item by its ID:
@@ -1459,7 +1459,7 @@ async function retrieveInventoryItem (id: string) {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1491,7 +1491,7 @@ async function retrieveInventoryItem (id: string) {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. This method is used to retrieve an inventory level for an inventory item and a location.
#### Example ##### Example
```ts ```ts
import { import {
@@ -1533,7 +1533,7 @@ async function retrieveInventoryLevel (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1565,7 +1565,7 @@ async function retrieveInventoryLevel (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1581,11 +1581,11 @@ async function retrieveInventoryLevel (
___ ___
### retrieveReservationItem #### retrieveReservationItem
This method is used to retrieve a reservation item by its ID. This method is used to retrieve a reservation item by its ID.
#### Example ##### Example
```ts ```ts
import { import {
@@ -1601,7 +1601,7 @@ async function retrieveReservationItem (id: string) {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1624,7 +1624,7 @@ async function retrieveReservationItem (id: string) {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. This method is used to retrieve the reserved quantity of an inventory item within the specified locations.
#### Example ##### Example
```ts ```ts
import { import {
@@ -1666,7 +1666,7 @@ async function retrieveReservedQuantity (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1698,7 +1698,7 @@ async function retrieveReservedQuantity (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. This method is used to retrieve the stocked quantity of an inventory item within the specified locations.
#### Example ##### Example
```ts ```ts
import { import {
@@ -1740,7 +1740,7 @@ async function retrieveStockedQuantity (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1772,7 +1772,7 @@ async function retrieveStockedQuantity (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1788,11 +1788,11 @@ async function retrieveStockedQuantity (
___ ___
### updateInventoryItem #### updateInventoryItem
This method is used to update an inventory item. This method is used to update an inventory item.
#### Example ##### Example
```ts ```ts
import { import {
@@ -1816,7 +1816,7 @@ async function updateInventoryItem (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1848,7 +1848,7 @@ async function updateInventoryItem (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. 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 ```ts
import { import {
@@ -1894,7 +1894,7 @@ async function updateInventoryLevel (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -1935,7 +1935,7 @@ async function updateInventoryLevel (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <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. 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 ```ts
import { import {
@@ -1977,7 +1977,7 @@ async function updateInventoryLevels (items: {
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -2000,7 +2000,7 @@ async function updateInventoryLevels (items: {
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -2016,11 +2016,11 @@ async function updateInventoryLevels (items: {
___ ___
### updateReservationItem #### updateReservationItem
This method is used to update a reservation item. This method is used to update a reservation item.
#### Example ##### Example
```ts ```ts
import { import {
@@ -2044,7 +2044,7 @@ async function updateReservationItem (
} }
``` ```
#### Parameters ##### Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -2076,7 +2076,7 @@ async function updateReservationItem (
} }
]} /> ]} />
#### Returns ##### Returns
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.ReserveQuantityContext.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ReserveQuantityContext # ReserveQuantityContext
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/enums/internal.internal-1.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx
+2 -2
View File
@@ -8,8 +8,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### ISOLATED #### ISOLATED
___ ___
### SHARED #### SHARED
www/apps/docs/content/references/js-client/ModulesSdkTypes/enums/internal.internal-1.ModulesSdkTypes.MODULE_SCOPE.mdx
+2 -2
View File
@@ -8,8 +8,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members ## Enumeration Members
### EXTERNAL #### EXTERNAL
___ ___
### INTERNAL #### INTERNAL
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.Constructor.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Constructor # Constructor
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
### Type declaration #### Type declaration
##### Parameters ##### Parameters
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ExternalModuleDeclaration # ExternalModuleDeclaration
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.InternalModuleDeclaration.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# InternalModuleDeclaration # InternalModuleDeclaration
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.LinkModuleDefinition.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# LinkModuleDefinition # LinkModuleDefinition
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.LoaderOptions.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# LoaderOptions # LoaderOptions
### Type parameters #### Type Parameters
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
} }
]} /> ]} />
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleDefinition.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleDefinition # ModuleDefinition
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleExports.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleExports # ModuleExports
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleLoaderFunction.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleLoaderFunction # ModuleLoaderFunction
### Type declaration #### Type declaration
##### Parameters ##### Parameters
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleResolution # ModuleResolution
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleServiceInitializeCustomDataLayerOptions # ModuleServiceInitializeCustomDataLayerOptions
### Type declaration #### Type declaration
<ParameterTypes parameters={[ <ParameterTypes parameters={[
{ {
www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.RemoteQueryFunction.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# RemoteQueryFunction # RemoteQueryFunction
### Type declaration #### Type declaration
##### Parameters ##### Parameters
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx
+75
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": []
}
]} />
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx
+66
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": []
}
]} />
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx
+30
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": []
}
]} />
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx
+102
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": []
}
]} />
www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx
+21
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": []
}
]} />

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