diff --git a/packages/types/src/product/service.ts b/packages/types/src/product/service.ts index 00b3320fe1..86c4593e16 100644 --- a/packages/types/src/product/service.ts +++ b/packages/types/src/product/service.ts @@ -1491,11 +1491,57 @@ export interface IProductModuleService { sharedContext?: Context ): Promise + /** + * 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} 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( data: UpdateProductVariantDTO[], sharedContext?: Context ): Promise + /** + * 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} 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( data: CreateProductVariantDTO[], sharedContext?: Context @@ -2437,7 +2483,7 @@ export interface IProductModuleService { * * @param {string[]} productIds - The IDs of the products to restore. * @param {RestoreReturn} 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`. * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module. * @returns {Promise | void>} @@ -2466,6 +2512,32 @@ export interface IProductModuleService { sharedContext?: Context ): Promise | 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} 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 | 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( variantIds: string[], config?: RestoreReturn, diff --git a/www/apps/docs/content/references/entities/classes/MoneyAmount.mdx b/www/apps/docs/content/references/entities/classes/MoneyAmount.mdx index b23c05a502..4ea8077f16 100644 --- a/www/apps/docs/content/references/entities/classes/MoneyAmount.mdx +++ b/www/apps/docs/content/references/entities/classes/MoneyAmount.mdx @@ -332,7 +332,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "region_id", - "type": "`string`", + "type": "`null` \\| `string`", "description": "The region's ID", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/PriceList.mdx b/www/apps/docs/content/references/entities/classes/PriceList.mdx index 940cd39cbc..74f8e73373 100644 --- a/www/apps/docs/content/references/entities/classes/PriceList.mdx +++ b/www/apps/docs/content/references/entities/classes/PriceList.mdx @@ -266,7 +266,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "region_id", - "type": "`string`", + "type": "`null` \\| `string`", "description": "The region's ID", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductVariant.mdx b/www/apps/docs/content/references/entities/classes/ProductVariant.mdx index 35dd602b78..52672c8984 100644 --- a/www/apps/docs/content/references/entities/classes/ProductVariant.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductVariant.mdx @@ -437,7 +437,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "region_id", - "type": "`string`", + "type": "`null` \\| `string`", "description": "The region's ID", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/enums/AllocationType.mdx b/www/apps/docs/content/references/entities/enums/AllocationType.mdx index cb71377b53..b05b0b0504 100644 --- a/www/apps/docs/content/references/entities/enums/AllocationType.mdx +++ b/www/apps/docs/content/references/entities/enums/AllocationType.mdx @@ -10,7 +10,7 @@ The scope that the discount should apply to. ## Enumeration Members -### ITEM +#### ITEM **ITEM** = `"item"` @@ -18,7 +18,7 @@ The discount should be applied to applicable items in the cart. ___ -### TOTAL +#### TOTAL **TOTAL** = `"total"` diff --git a/www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx b/www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx index 2a4b2151a6..b2c5e0b950 100644 --- a/www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx @@ -8,42 +8,42 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` ___ -### COMPLETED +#### COMPLETED **COMPLETED** = `"completed"` ___ -### CONFIRMED +#### CONFIRMED **CONFIRMED** = `"confirmed"` ___ -### CREATED +#### CREATED **CREATED** = `"created"` ___ -### FAILED +#### FAILED **FAILED** = `"failed"` ___ -### PRE\_PROCESSED +#### PRE\_PROCESSED **PRE\_PROCESSED** = `"pre_processed"` ___ -### PROCESSING +#### PROCESSING **PROCESSING** = `"processing"` diff --git a/www/apps/docs/content/references/entities/enums/CartType.mdx b/www/apps/docs/content/references/entities/enums/CartType.mdx index c78f78f7ce..401129bcaf 100644 --- a/www/apps/docs/content/references/entities/enums/CartType.mdx +++ b/www/apps/docs/content/references/entities/enums/CartType.mdx @@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### CLAIM +#### CLAIM **CLAIM** = `"claim"` ___ -### DEFAULT +#### DEFAULT **DEFAULT** = `"default"` ___ -### DRAFT\_ORDER +#### DRAFT\_ORDER **DRAFT\_ORDER** = `"draft_order"` ___ -### PAYMENT\_LINK +#### PAYMENT\_LINK **PAYMENT\_LINK** = `"payment_link"` ___ -### SWAP +#### SWAP **SWAP** = `"swap"` diff --git a/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx index 9640e72599..6bca914bdd 100644 --- a/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx @@ -10,7 +10,7 @@ The claim's fulfillment status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The claim's fulfillments are canceled. ___ -### FULFILLED +#### FULFILLED **FULFILLED** = `"fulfilled"` @@ -26,7 +26,7 @@ The claim's replacement items are fulfilled. ___ -### NOT\_FULFILLED +#### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` @@ -34,7 +34,7 @@ The claim's replacement items are not fulfilled. ___ -### PARTIALLY\_FULFILLED +#### PARTIALLY\_FULFILLED **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` @@ -42,7 +42,7 @@ Some of the claim's replacement items, but not all, are fulfilled. ___ -### PARTIALLY\_RETURNED +#### PARTIALLY\_RETURNED **PARTIALLY\_RETURNED** = `"partially_returned"` @@ -50,7 +50,7 @@ Some of the claim's items, but not all, are returned. ___ -### PARTIALLY\_SHIPPED +#### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` @@ -58,7 +58,7 @@ Some of the claim's replacement items, but not all, are shipped. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` @@ -66,7 +66,7 @@ The claim's fulfillment requires action. ___ -### RETURNED +#### RETURNED **RETURNED** = `"returned"` @@ -74,7 +74,7 @@ The claim's items are returned. ___ -### SHIPPED +#### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx index 4a7aabbcac..05e3d57ce7 100644 --- a/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx @@ -10,7 +10,7 @@ The claim's payment status ## Enumeration Members -### NA +#### NA **NA** = `"na"` @@ -18,7 +18,7 @@ The payment status isn't set, which is typically used when the claim's type is ` ___ -### NOT\_REFUNDED +#### NOT\_REFUNDED **NOT\_REFUNDED** = `"not_refunded"` @@ -26,7 +26,7 @@ The payment isn't refunded. ___ -### REFUNDED +#### REFUNDED **REFUNDED** = `"refunded"` diff --git a/www/apps/docs/content/references/entities/enums/ClaimReason.mdx b/www/apps/docs/content/references/entities/enums/ClaimReason.mdx index 6300920b54..5d9e70c44f 100644 --- a/www/apps/docs/content/references/entities/enums/ClaimReason.mdx +++ b/www/apps/docs/content/references/entities/enums/ClaimReason.mdx @@ -8,24 +8,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### MISSING\_ITEM +#### MISSING\_ITEM **MISSING\_ITEM** = `"missing_item"` ___ -### OTHER +#### OTHER **OTHER** = `"other"` ___ -### PRODUCTION\_FAILURE +#### PRODUCTION\_FAILURE **PRODUCTION\_FAILURE** = `"production_failure"` ___ -### WRONG\_ITEM +#### WRONG\_ITEM **WRONG\_ITEM** = `"wrong_item"` diff --git a/www/apps/docs/content/references/entities/enums/ClaimType.mdx b/www/apps/docs/content/references/entities/enums/ClaimType.mdx index 23eabada69..929041ee9e 100644 --- a/www/apps/docs/content/references/entities/enums/ClaimType.mdx +++ b/www/apps/docs/content/references/entities/enums/ClaimType.mdx @@ -10,7 +10,7 @@ The claim's type. ## Enumeration Members -### REFUND +#### REFUND **REFUND** = `"refund"` @@ -18,7 +18,7 @@ The claim refunds an amount to the customer. ___ -### REPLACE +#### REPLACE **REPLACE** = `"replace"` diff --git a/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx b/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx index d4146cca85..5906ead960 100644 --- a/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx +++ b/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx @@ -10,7 +10,7 @@ The possible operators used for a discount condition. ## Enumeration Members -### IN +#### IN **IN** = `"in"` @@ -18,7 +18,7 @@ The discountable resources are within the specified resources. ___ -### NOT\_IN +#### NOT\_IN **NOT\_IN** = `"not_in"` diff --git a/www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx b/www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx index cd13c91243..864681779c 100644 --- a/www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx +++ b/www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx @@ -10,7 +10,7 @@ The discount condition's type. ## Enumeration Members -### CUSTOMER\_GROUPS +#### CUSTOMER\_GROUPS **CUSTOMER\_GROUPS** = `"customer_groups"` @@ -18,7 +18,7 @@ The discount condition is used for customer groups. ___ -### PRODUCTS +#### PRODUCTS **PRODUCTS** = `"products"` @@ -26,7 +26,7 @@ The discount condition is used for products. ___ -### PRODUCT\_COLLECTIONS +#### PRODUCT\_COLLECTIONS **PRODUCT\_COLLECTIONS** = `"product_collections"` @@ -34,7 +34,7 @@ The discount condition is used for product collections. ___ -### PRODUCT\_TAGS +#### PRODUCT\_TAGS **PRODUCT\_TAGS** = `"product_tags"` @@ -42,7 +42,7 @@ The discount condition is used for product tags. ___ -### PRODUCT\_TYPES +#### PRODUCT\_TYPES **PRODUCT\_TYPES** = `"product_types"` diff --git a/www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx b/www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx index 7905738dfd..48fd94f166 100644 --- a/www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx +++ b/www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx @@ -10,7 +10,7 @@ The possible types of discount rules. ## Enumeration Members -### FIXED +#### FIXED **FIXED** = `"fixed"` @@ -18,7 +18,7 @@ Discounts that reduce the price by a fixed amount. ___ -### FREE\_SHIPPING +#### FREE\_SHIPPING **FREE\_SHIPPING** = `"free_shipping"` @@ -26,7 +26,7 @@ Discounts that sets the shipping price to `0`. ___ -### PERCENTAGE +#### PERCENTAGE **PERCENTAGE** = `"percentage"` diff --git a/www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx b/www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx index 87026819d2..ba4212d8ab 100644 --- a/www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx @@ -10,7 +10,7 @@ The draft order's status. ## Enumeration Members -### COMPLETED +#### COMPLETED **COMPLETED** = `"completed"` @@ -18,7 +18,7 @@ The draft order is completed, and an order has been created from it. ___ -### OPEN +#### OPEN **OPEN** = `"open"` diff --git a/www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx index 560234d78a..c43bd91df7 100644 --- a/www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx @@ -10,7 +10,7 @@ The order's fulfillment status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The order's fulfillments are canceled. ___ -### FULFILLED +#### FULFILLED **FULFILLED** = `"fulfilled"` @@ -26,7 +26,7 @@ The order's items are fulfilled. ___ -### NOT\_FULFILLED +#### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` @@ -34,7 +34,7 @@ The order's items are not fulfilled. ___ -### PARTIALLY\_FULFILLED +#### PARTIALLY\_FULFILLED **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` @@ -42,7 +42,7 @@ Some of the order's items, but not all, are fulfilled. ___ -### PARTIALLY\_RETURNED +#### PARTIALLY\_RETURNED **PARTIALLY\_RETURNED** = `"partially_returned"` @@ -50,7 +50,7 @@ Some of the order's items, but not all, are returned. ___ -### PARTIALLY\_SHIPPED +#### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` @@ -58,7 +58,7 @@ Some of the order's items, but not all, are shipped. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` @@ -66,7 +66,7 @@ The order's fulfillment requires action. ___ -### RETURNED +#### RETURNED **RETURNED** = `"returned"` @@ -74,7 +74,7 @@ The order's items are returned. ___ -### SHIPPED +#### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx b/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx index 92c6cabab5..eb44a8e5b5 100644 --- a/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx +++ b/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx @@ -10,7 +10,7 @@ The type of the order edit item change. ## Enumeration Members -### ITEM\_ADD +#### ITEM\_ADD **ITEM\_ADD** = `"item_add"` @@ -18,7 +18,7 @@ A new item to be added to the original order. ___ -### ITEM\_REMOVE +#### ITEM\_REMOVE **ITEM\_REMOVE** = `"item_remove"` @@ -26,7 +26,7 @@ An existing item to be removed from the original order. ___ -### ITEM\_UPDATE +#### ITEM\_UPDATE **ITEM\_UPDATE** = `"item_update"` diff --git a/www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx b/www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx index e965d5f26b..2b63c41b80 100644 --- a/www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx @@ -10,7 +10,7 @@ The order edit's status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The order edit is canceled. ___ -### CONFIRMED +#### CONFIRMED **CONFIRMED** = `"confirmed"` @@ -26,7 +26,7 @@ The order edit is confirmed. ___ -### CREATED +#### CREATED **CREATED** = `"created"` @@ -34,7 +34,7 @@ The order edit is created. ___ -### DECLINED +#### DECLINED **DECLINED** = `"declined"` @@ -42,7 +42,7 @@ The order edit is declined. ___ -### REQUESTED +#### REQUESTED **REQUESTED** = `"requested"` diff --git a/www/apps/docs/content/references/entities/enums/OrderStatus.mdx b/www/apps/docs/content/references/entities/enums/OrderStatus.mdx index 9427b7ad56..60d4dd6001 100644 --- a/www/apps/docs/content/references/entities/enums/OrderStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/OrderStatus.mdx @@ -10,7 +10,7 @@ The order's status. ## Enumeration Members -### ARCHIVED +#### ARCHIVED **ARCHIVED** = `"archived"` @@ -18,7 +18,7 @@ The order is archived. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -26,7 +26,7 @@ The order is canceled. ___ -### COMPLETED +#### COMPLETED **COMPLETED** = `"completed"` @@ -36,7 +36,7 @@ has been captured. ___ -### PENDING +#### PENDING **PENDING** = `"pending"` @@ -44,7 +44,7 @@ The order is pending. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx b/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx index 5f0e6ffb4f..c011988b08 100644 --- a/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx @@ -10,7 +10,7 @@ The payment collection's status. ## Enumeration Members -### AUTHORIZED +#### AUTHORIZED **AUTHORIZED** = `"authorized"` @@ -18,7 +18,7 @@ The payment colleciton is authorized. ___ -### AWAITING +#### AWAITING **AWAITING** = `"awaiting"` @@ -26,7 +26,7 @@ The payment collection is awaiting payment. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -34,7 +34,7 @@ The payment collection is canceled. ___ -### NOT\_PAID +#### NOT\_PAID **NOT\_PAID** = `"not_paid"` @@ -42,7 +42,7 @@ The payment collection isn't paid. ___ -### PARTIALLY\_AUTHORIZED +#### PARTIALLY\_AUTHORIZED **PARTIALLY\_AUTHORIZED** = `"partially_authorized"` diff --git a/www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx b/www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx index b1f8feed0a..454e617049 100644 --- a/www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx +++ b/www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx @@ -10,7 +10,7 @@ The payment collection's type. ## Enumeration Members -### ORDER\_EDIT +#### ORDER\_EDIT **ORDER\_EDIT** = `"order_edit"` diff --git a/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx b/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx index 6cc3711019..f45190a1a3 100644 --- a/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx @@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### AUTHORIZED +#### AUTHORIZED **AUTHORIZED** = `"authorized"` ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` ___ -### ERROR +#### ERROR **ERROR** = `"error"` ___ -### PENDING +#### PENDING **PENDING** = `"pending"` ___ -### REQUIRES\_MORE +#### REQUIRES\_MORE **REQUIRES\_MORE** = `"requires_more"` diff --git a/www/apps/docs/content/references/entities/enums/PaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/PaymentStatus.mdx index f1e020cb06..0b8f68c06c 100644 --- a/www/apps/docs/content/references/entities/enums/PaymentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/PaymentStatus.mdx @@ -10,7 +10,7 @@ The order's payment status. ## Enumeration Members -### AWAITING +#### AWAITING **AWAITING** = `"awaiting"` @@ -18,7 +18,7 @@ The order's payment is awaiting capturing. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -26,7 +26,7 @@ The order's payment is canceled. ___ -### CAPTURED +#### CAPTURED **CAPTURED** = `"captured"` @@ -34,7 +34,7 @@ The order's payment is captured. ___ -### NOT\_PAID +#### NOT\_PAID **NOT\_PAID** = `"not_paid"` @@ -42,7 +42,7 @@ The order's payment is not paid. ___ -### PARTIALLY\_REFUNDED +#### PARTIALLY\_REFUNDED **PARTIALLY\_REFUNDED** = `"partially_refunded"` @@ -50,7 +50,7 @@ Some of the order's payment amount is refunded. ___ -### REFUNDED +#### REFUNDED **REFUNDED** = `"refunded"` @@ -58,7 +58,7 @@ The order's payment amount is refunded. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx b/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx index 458f0df10c..e65894337b 100644 --- a/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx @@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### ACTIVE +#### ACTIVE **ACTIVE** = `"active"` ___ -### DRAFT +#### DRAFT **DRAFT** = `"draft"` diff --git a/www/apps/docs/content/references/entities/enums/PriceListType.mdx b/www/apps/docs/content/references/entities/enums/PriceListType.mdx index f079104657..5d238410a5 100644 --- a/www/apps/docs/content/references/entities/enums/PriceListType.mdx +++ b/www/apps/docs/content/references/entities/enums/PriceListType.mdx @@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### OVERRIDE +#### OVERRIDE **OVERRIDE** = `"override"` ___ -### SALE +#### SALE **SALE** = `"sale"` diff --git a/www/apps/docs/content/references/entities/enums/ProductStatus.mdx b/www/apps/docs/content/references/entities/enums/ProductStatus.mdx index 0f7c8b46df..942720d6c7 100644 --- a/www/apps/docs/content/references/entities/enums/ProductStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/ProductStatus.mdx @@ -10,7 +10,7 @@ The status of a product. ## Enumeration Members -### DRAFT +#### DRAFT **DRAFT** = `"draft"` @@ -18,7 +18,7 @@ The product is a draft. It's not viewable by customers. ___ -### PROPOSED +#### PROPOSED **PROPOSED** = `"proposed"` @@ -26,7 +26,7 @@ The product is proposed, but not yet published. ___ -### PUBLISHED +#### PUBLISHED **PUBLISHED** = `"published"` @@ -34,7 +34,7 @@ The product is published. ___ -### REJECTED +#### REJECTED **REJECTED** = `"rejected"` diff --git a/www/apps/docs/content/references/entities/enums/RefundReason.mdx b/www/apps/docs/content/references/entities/enums/RefundReason.mdx index 1ca51325cb..73dda8f429 100644 --- a/www/apps/docs/content/references/entities/enums/RefundReason.mdx +++ b/www/apps/docs/content/references/entities/enums/RefundReason.mdx @@ -10,7 +10,7 @@ The reason of the refund. ## Enumeration Members -### CLAIM +#### CLAIM **CLAIM** = `"claim"` @@ -18,7 +18,7 @@ The refund is applied because of a created claim. ___ -### DISCOUNT +#### DISCOUNT **DISCOUNT** = `"discount"` @@ -26,7 +26,7 @@ The refund is applied as a discount. ___ -### OTHER +#### OTHER **OTHER** = `"other"` @@ -34,7 +34,7 @@ The refund is created for a custom reason. ___ -### RETURN +#### RETURN **RETURN** = `"return"` @@ -42,7 +42,7 @@ The refund is applied because of a created return. ___ -### SWAP +#### SWAP **SWAP** = `"swap"` diff --git a/www/apps/docs/content/references/entities/enums/RequirementType.mdx b/www/apps/docs/content/references/entities/enums/RequirementType.mdx index 8c9caa134a..b835485cb6 100644 --- a/www/apps/docs/content/references/entities/enums/RequirementType.mdx +++ b/www/apps/docs/content/references/entities/enums/RequirementType.mdx @@ -10,7 +10,7 @@ The type of shipping option requirement. ## Enumeration Members -### MAX\_SUBTOTAL +#### MAX\_SUBTOTAL **MAX\_SUBTOTAL** = `"max_subtotal"` @@ -18,7 +18,7 @@ The shipping option can only be applied if the subtotal is less than the require ___ -### MIN\_SUBTOTAL +#### MIN\_SUBTOTAL **MIN\_SUBTOTAL** = `"min_subtotal"` diff --git a/www/apps/docs/content/references/entities/enums/ReturnStatus.mdx b/www/apps/docs/content/references/entities/enums/ReturnStatus.mdx index 7d86a5fe10..2408d800b3 100644 --- a/www/apps/docs/content/references/entities/enums/ReturnStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/ReturnStatus.mdx @@ -10,7 +10,7 @@ The return's status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The return is canceled. ___ -### RECEIVED +#### RECEIVED **RECEIVED** = `"received"` @@ -26,7 +26,7 @@ The return is received. ___ -### REQUESTED +#### REQUESTED **REQUESTED** = `"requested"` @@ -34,7 +34,7 @@ The return is requested. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx b/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx index fb58a0f17b..9fbbbdaf80 100644 --- a/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx +++ b/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx @@ -10,7 +10,7 @@ The type of the shipping option price. ## Enumeration Members -### CALCULATED +#### CALCULATED **CALCULATED** = `"calculated"` @@ -18,7 +18,7 @@ The shipping option's price is calculated. In this case, the `amount` field is t ___ -### FLAT\_RATE +#### FLAT\_RATE **FLAT\_RATE** = `"flat_rate"` diff --git a/www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx b/www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx index eb986e3d76..b59baaf208 100644 --- a/www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx +++ b/www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx @@ -10,7 +10,7 @@ The shipping profile's type. ## Enumeration Members -### CUSTOM +#### CUSTOM **CUSTOM** = `"custom"` @@ -18,7 +18,7 @@ The profile used to ship custom items. ___ -### DEFAULT +#### DEFAULT **DEFAULT** = `"default"` @@ -26,7 +26,7 @@ The default profile used to ship item. ___ -### GIFT\_CARD +#### GIFT\_CARD **GIFT\_CARD** = `"gift_card"` diff --git a/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx index 2997ee1d1b..fbd0bd3c0c 100644 --- a/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx @@ -10,7 +10,7 @@ The swap's fulfillment status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The swap's fulfillments are canceled. ___ -### FULFILLED +#### FULFILLED **FULFILLED** = `"fulfilled"` @@ -26,7 +26,7 @@ The swap's items are fulfilled. ___ -### NOT\_FULFILLED +#### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` @@ -34,7 +34,7 @@ The swap's items aren't fulfilled. ___ -### PARTIALLY\_SHIPPED +#### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` @@ -42,7 +42,7 @@ Some of the swap's items are shipped. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` @@ -50,7 +50,7 @@ The swap's fulfillments require an action. ___ -### SHIPPED +#### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx index 3804a0f19c..fa7af904f3 100644 --- a/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx @@ -10,7 +10,7 @@ The swap's payment status. ## Enumeration Members -### AWAITING +#### AWAITING **AWAITING** = `"awaiting"` @@ -18,7 +18,7 @@ The swap is additional awaiting payment. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -26,7 +26,7 @@ The swap's additional payment is canceled. ___ -### CAPTURED +#### CAPTURED **CAPTURED** = `"captured"` @@ -34,7 +34,7 @@ The swap's additional payment is captured. ___ -### CONFIRMED +#### CONFIRMED **CONFIRMED** = `"confirmed"` @@ -42,7 +42,7 @@ The swap's additional payment is confirmed. ___ -### DIFFERENCE\_REFUNDED +#### DIFFERENCE\_REFUNDED **DIFFERENCE\_REFUNDED** = `"difference_refunded"` @@ -50,7 +50,7 @@ The negative difference amount between the returned item(s) and the new one(s) h ___ -### NOT\_PAID +#### NOT\_PAID **NOT\_PAID** = `"not_paid"` @@ -58,7 +58,7 @@ The swap's additional payment isn't paid. ___ -### PARTIALLY\_REFUNDED +#### PARTIALLY\_REFUNDED **PARTIALLY\_REFUNDED** = `"partially_refunded"` @@ -66,7 +66,7 @@ Some of the negative difference amount between the returned item(s) and the new ___ -### REFUNDED +#### REFUNDED **REFUNDED** = `"refunded"` @@ -74,7 +74,7 @@ The amount in the associated order has been refunded. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/UserRoles.mdx b/www/apps/docs/content/references/entities/enums/UserRoles.mdx index 52717c53c2..a2bb57bb56 100644 --- a/www/apps/docs/content/references/entities/enums/UserRoles.mdx +++ b/www/apps/docs/content/references/entities/enums/UserRoles.mdx @@ -10,7 +10,7 @@ The user's role. These roles don't change the user's capabilities or provide acc ## Enumeration Members -### ADMIN +#### ADMIN **ADMIN** = `"admin"` @@ -18,7 +18,7 @@ The user is an admin. ___ -### DEVELOPER +#### DEVELOPER **DEVELOPER** = `"developer"` @@ -26,7 +26,7 @@ The user is a developer. ___ -### MEMBER +#### MEMBER **MEMBER** = `"member"` diff --git a/www/apps/docs/content/references/entities/index.mdx b/www/apps/docs/content/references/entities/index.mdx index 2dd051419b..79d66c70a6 100644 --- a/www/apps/docs/content/references/entities/index.mdx +++ b/www/apps/docs/content/references/entities/index.mdx @@ -137,10 +137,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Functions -### Boolean +#### Boolean `**Boolean**(value?): boolean` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` diff --git a/www/apps/docs/content/references/entities/types/BatchJobResultError.mdx b/www/apps/docs/content/references/entities/types/BatchJobResultError.mdx index 9fc9533169..00c67ac674 100644 --- a/www/apps/docs/content/references/entities/types/BatchJobResultError.mdx +++ b/www/apps/docs/content/references/entities/types/BatchJobResultError.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **BatchJobResultError**: `Object` -### Index signature +#### Index signature ▪ [key: `string`]: `unknown` -### Type declaration +#### Type declaration `: { [P in K]: T } + **Record**: { [P in K]: T } Construct a type with a set of properties K of type T -### Type parameters +#### Type Parameters `: `T` extends `U` ? `never` : `T` + **Exclude**: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U -### Type parameters +#### Type Parameters `: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> + **Omit**: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> Construct a type with the properties of T except for those in type K. -### Type parameters +#### Type Parameters `: { [P in keyof T]?: T[P] } + **Partial**: { [P in keyof T]?: T[P] } Make all properties in T optional -### Type parameters +#### Type Parameters `: { [P in K]: T[P] } + **Pick**: { [P in K]: T[P] } From T, pick a set of properties whose keys are in the union K -### Type parameters +#### Type Parameters `: { [P in K]: T } + **Record**: { [P in K]: T } Construct a type with a set of properties K of type T -### Type parameters +#### Type Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -### Type declaration +#### Type declaration -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns + ___ -### getFreshManager +#### getFreshManager -#### Returns +##### Returns - + ___ -### restore +#### restore -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns + ___ -### getFreshManager +#### getFreshManager -#### Returns +##### Returns - + ___ -### serialize +#### serialize -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -### Type declaration +#### Type declaration (eventName, data, options?): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns (data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration ##### Parameters diff --git a/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx b/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx index 91f882f342..0fb858da32 100644 --- a/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx +++ b/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Subscriber -### Type parameters +#### Type Parameters -### Type declaration +#### Type declaration ##### Parameters diff --git a/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx b/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx index c744084d3d..2c8a63ed6c 100644 --- a/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx +++ b/www/apps/docs/content/references/js-client/EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # SubscriberContext -### Type declaration +#### Type declaration -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + #### Since @@ -104,14 +114,14 @@ v14.8.0, v12.19.0 ___ -### emitDestroy +#### emitDestroy Call all `destroy` hooks. This should only ever be called once. An error will be thrown if it is called more than once. This **must** be manually called. If the resource is left to be collected by the GC then the `destroy` hooks will never be called. -#### Returns +##### Returns -#### Returns +##### Returns - + #### Since @@ -176,9 +196,9 @@ v9.6.0 ___ -### triggerAsyncId +#### triggerAsyncId -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -### Type declaration +#### Type declaration ##### Parameters diff --git a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx index 80744bf80d..eb8acb1b8b 100644 --- a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx +++ b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ExternalModuleDeclaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx new file mode 100644 index 0000000000..453ef89ff1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx @@ -0,0 +1,66 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListPriceDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx new file mode 100644 index 0000000000..a9602996b9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRuleDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx new file mode 100644 index 0000000000..e9d200309e --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx @@ -0,0 +1,102 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListWorkflowDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx new file mode 100644 index 0000000000..d2c4d5d56e --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListWorkflowInputDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx new file mode 100644 index 0000000000..6b99b3c1ed --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RemovePriceListPricesWorkflowInputDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx new file mode 100644 index 0000000000..37aef9a057 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RemovePriceListProductsWorkflowInputDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx new file mode 100644 index 0000000000..4230cd2c6c --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RemovePriceListVariantsWorkflowInputDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx new file mode 100644 index 0000000000..f3229a65e8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RemovePriceListWorkflowInputDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx new file mode 100644 index 0000000000..71d3a5efe0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx @@ -0,0 +1,84 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListWorkflowDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx new file mode 100644 index 0000000000..cefc95e252 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/interfaces/internal.internal-1.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListWorkflowInputDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PriceListWorkflow/types/internal.internal-1.WorkflowTypes.PriceListWorkflow.PriceListVariantPriceDTO.mdx b/www/apps/docs/content/references/js-client/PriceListWorkflow/types/internal.internal-1.WorkflowTypes.PriceListWorkflow.PriceListVariantPriceDTO.mdx new file mode 100644 index 0000000000..b077e58765 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PriceListWorkflow/types/internal.internal-1.WorkflowTypes.PriceListWorkflow.PriceListVariantPriceDTO.mdx @@ -0,0 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListVariantPriceDTO diff --git a/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx index 7117ba17dc..22b0a49e81 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx @@ -10,12 +10,12 @@ The price list's status. ## Enumeration Members -### ACTIVE +#### ACTIVE The price list is enabled and its prices can be used. ___ -### DRAFT +#### DRAFT The price list is disabled, meaning its prices can't be used yet. diff --git a/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx index 8612f7faa1..ecd7f401b1 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx @@ -10,12 +10,12 @@ The price list's type. ## Enumeration Members -### OVERRIDE +#### OVERRIDE The price list's prices override original prices. This affects the calculated price of associated price sets. ___ -### SALE +#### SALE The price list's prices are used for a sale. diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx index 61f3a554a2..eb68fdca40 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx @@ -7,4 +7,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreatePriceListRules The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value - * is the values of the rule. +is the values of the rule. diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx index 34238aa563..5565a3c940 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### addPriceListPrices +#### addPriceListPrices This method is used to add prices to price lists. -#### Example +##### Example ```ts import { @@ -35,7 +35,7 @@ async function addPriceListPrices (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx index f01b7f2dd1..da22d35fdf 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx @@ -13,7 +13,7 @@ The attributes to update in a price list. -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns + +##### Returns + + + +___ + +#### delete This method is used to delete products. Unlike the [softDelete](internal.internal-1.ProductTypes.IProductModuleService.mdx#softdelete) method, this method will completely remove the products and they can no longer be accessed or retrieved. -#### Example +##### Example ```ts import { @@ -404,7 +445,7 @@ async function deleteProducts (ids: string[]) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns + +##### Returns + + + +___ + +#### list This method is used to retrieve a paginated list of price sets based on optional filters and configuration. -#### Example +##### Example To retrieve a list of products using their IDs: @@ -824,7 +922,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns + +___ + +#### updateVariants + +##### Parameters + + + +##### Returns + + diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx index 7d1d47d4fb..88daf74255 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx @@ -41,10 +41,10 @@ The product option value's data. { "name": "option", "type": "[ProductOptionDTO](internal.internal-1.ProductTypes.ProductOptionDTO.mdx)", - "description": "The associated product option.", + "description": "The associated product option. It may only be available if the `option` relation is expanded.", "optional": false, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] }, { @@ -59,10 +59,10 @@ The product option value's data. { "name": "variant", "type": "[ProductVariantDTO](internal.internal-1.ProductTypes.ProductVariantDTO.mdx)", - "description": "The associated product variant.", + "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", "optional": false, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ]} /> diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx index 2e8899d066..c4cf7d0370 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx @@ -139,7 +139,7 @@ A product variant's data. }, { "name": "options", - "type": "[ProductOptionValueDTO](internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)", + "type": "[ProductOptionValueDTO](internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)[]", "description": "The associated product options.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductWorkflow/interfaces/internal.internal-1.WorkflowTypes.ProductWorkflow.CreateProductVariantsInputDTO.mdx b/www/apps/docs/content/references/js-client/ProductWorkflow/interfaces/internal.internal-1.WorkflowTypes.ProductWorkflow.CreateProductVariantsInputDTO.mdx new file mode 100644 index 0000000000..42109b09b9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/ProductWorkflow/interfaces/internal.internal-1.WorkflowTypes.ProductWorkflow.CreateProductVariantsInputDTO.mdx @@ -0,0 +1,192 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreateProductVariantsInputDTO + +## Properties + +`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "options", + "type": "[UpsertProductVariantOptionInputDTO](internal.internal-1.WorkflowTypes.ProductWorkflow.UpsertProductVariantOptionInputDTO.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "prices", + "type": "[UpsertProductVariantPricesInputDTO](internal.internal-1.WorkflowTypes.ProductWorkflow.UpsertProductVariantPricesInputDTO.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/ProductWorkflow/interfaces/internal.internal-1.WorkflowTypes.ProductWorkflow.CreateProductVariantsWorkflowInputDTO.mdx b/www/apps/docs/content/references/js-client/ProductWorkflow/interfaces/internal.internal-1.WorkflowTypes.ProductWorkflow.CreateProductVariantsWorkflowInputDTO.mdx new file mode 100644 index 0000000000..9fee8d519f --- /dev/null +++ b/www/apps/docs/content/references/js-client/ProductWorkflow/interfaces/internal.internal-1.WorkflowTypes.ProductWorkflow.CreateProductVariantsWorkflowInputDTO.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreateProductVariantsWorkflowInputDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx b/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx index 23601c7a3d..7d50da4d43 100644 --- a/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx +++ b/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx @@ -22,11 +22,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### addDocuments +#### addDocuments Used to index documents by the search engine provider -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### updateAddress +#### updateAddress Update an address of the logged-in customer. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -577,7 +577,7 @@ medusa.customers.addresses }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### getToken +#### getToken Authenticate the user and retrieve a JWT token to use for subsequent authenticated requests. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -424,7 +424,7 @@ medusa.admin.auth }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### confirm +#### confirm When a batch job is created, it's not executed automatically if `dry_run` is set to `true`. This method confirms that the batch job should be executed. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -262,7 +262,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### create +#### create Create a Batch Job to be executed asynchronously in the Medusa backend. If `dry_run` is set to `true`, the batch job will not be executed until the it is confirmed, which can be done using the [confirm](AdminBatchJobsResource.mdx#confirm) method. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -495,7 +495,7 @@ medusa.admin.batchJobs.create({ }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a product collection's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1117,7 +1117,7 @@ medusa.admin.collections }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { "defaultValue": "", "description": "The response data.", "expandable": false, - "children": [] + "children": [ + { + "name": "TResponse", + "type": "`TResponse`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + } + ] } ]} /> ___ -### get +#### get Send a `GET` request to a custom API Route. The method accepts a tuple of type parameters: the first `TQuery` is the type of accepted query parameters, which defaults to `Record`; the second `TResponse` is the type of response, which defaults to `any`. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -116,7 +126,7 @@ medusa.admin.custom.get, PostsResponse>( }) ``` -#### Parameters +##### Parameters , PostsResponse>( } ]} /> -#### Returns +##### Returns , PostsResponse>( "defaultValue": "", "description": "The response data.", "expandable": false, - "children": [] + "children": [ + { + "name": "TResponse", + "type": "`TResponse`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + } + ] } ]} /> ___ -### post +#### post Send a `POST` request to a custom API Route. The method accepts a tuple of type parameters: the first `TPayload` is the type of accepted body parameters, which defaults to `Record`; the second `TResponse` is the type of response, which defaults to `any`. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -220,7 +240,7 @@ medusa.admin.custom.post( }) ``` -#### Parameters +##### Parameters ( } ]} /> -#### Returns +##### Returns ( "defaultValue": "", "description": "The response data.", "expandable": false, - "children": [] + "children": [ + { + "name": "TResponse", + "type": "`TResponse`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + } + ] } ]} /> diff --git a/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx index c427d81ae1..daa04c52d3 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx @@ -19,11 +19,11 @@ Related Guide: [How to manage customer groups](https://docs.medusajs.com/modules ## Methods -### addCustomers +#### addCustomers Add a list of customers to a customer group. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a customer's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -845,7 +845,7 @@ medusa.admin.customers }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### create +#### create Create a discount with a given set of rules that defines how the discount is applied. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -625,7 +625,7 @@ medusa.admin.discounts }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deleteCondition +#### deleteCondition Delete a discount condition. This doesn't delete resources associated to the discount condition. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1844,7 +1844,7 @@ medusa.admin.discounts }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieveByCode +#### retrieveByCode Retrieve a discount's details by its discount code. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -3641,7 +3641,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a discount with a given set of rules that define how the discount is applied. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -3882,7 +3882,7 @@ medusa.admin.discounts }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### removeLineItem +#### removeLineItem Delete a Line Item from a Draft Order. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1635,7 +1635,7 @@ medusa.admin.draftOrders }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a Draft Order's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -2050,7 +2050,7 @@ medusa.admin.draftOrders }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### list +#### list Retrieve a list of gift cards. The gift cards can be filtered by fields such as `q` passed in the `query` parameter. The gift cards can also paginated. -#### Example +##### Example To list gift cards: @@ -394,7 +394,7 @@ medusa.admin.giftCards }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a gift card's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -873,7 +873,7 @@ medusa.admin.giftCards }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### list +#### list Retrieve a list of invites. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -311,7 +311,7 @@ medusa.admin.invites.list().then(({ invites }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### resend +#### resend Resend an invite. This renews the expiry date by seven days and generates a new token for the invite. It also triggers the `invite.created` event, so if you have a Notification Provider installed that handles this event, a notification should be sent to the email associated with the invite to allow them to accept the invite. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -474,7 +474,7 @@ medusa.admin.invites }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### list +#### list Retrieve a list of notes. The notes can be filtered by fields such as `resource_id` passed in the `query` parameter. The notes can also be paginated. -#### Example +##### Example To list notes: @@ -330,7 +330,7 @@ medusa.admin.notes }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a Note's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -719,7 +719,7 @@ medusa.admin.notes }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### confirm +#### confirm Confirm an order edit. This will reflect the changes in the order edit on the associated order. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -748,7 +748,7 @@ medusa.admin.orderEdits.confirm(orderEditId).then(({ order_edit }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### create +#### create Create an order edit. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1084,7 +1084,7 @@ medusa.admin.orderEdits.create({ orderId }).then(({ order_edit }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### delete +#### delete Delete an order edit. Only order edits that have the status `created` can be deleted. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1448,7 +1448,7 @@ medusa.admin.orderEdits.delete(orderEditId).then(({ id, object, deleted }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deleteItemChange +#### deleteItemChange Delete a line item change that indicates the addition, deletion, or update of a line item in the original order. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1532,7 +1532,7 @@ medusa.admin.orderEdits }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### cancel +#### cancel Cancel an order and change its status. This will also cancel any associated fulfillments and payments, and it may fail if the payment or fulfillment Provider is unable to cancel the payment/fulfillment. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -205,7 +205,7 @@ medusa.admin.orders.cancel(orderId).then(({ order }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### cancelClaim +#### cancelClaim Cancel a claim and change its status. A claim can't be canceled if it has a refund, if its fulfillments haven't been canceled, of if its associated return hasn't been canceled. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -269,7 +269,7 @@ medusa.admin.orders.cancelClaim(orderId, claimId).then(({ order }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### cancelClaimFulfillment +#### cancelClaimFulfillment Cancel a claim's fulfillment and change its fulfillment status to `canceled`. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -344,7 +344,7 @@ medusa.admin.orders }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### cancelSwapFulfillment +#### cancelSwapFulfillment Cancel a swap's fulfillment and change its fulfillment status to `canceled`. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -576,7 +576,7 @@ medusa.admin.orders }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### complete +#### complete Complete an order and change its status. A canceled order can't be completed. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -722,7 +722,7 @@ medusa.admin.orders.complete(orderId).then(({ order }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### createClaim +#### createClaim Create a claim for an order. If a return shipping method is specified, a return will also be created and associated with the claim. If the claim's type is `refund`, the refund is processed as well. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -797,7 +797,7 @@ medusa.admin.orders }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### fulfillSwap +#### fulfillSwap Create a Fulfillment for a Swap and change its fulfillment status to `fulfilled`. If it requires any additional actions, its fulfillment status may change to `requires_action`. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1679,7 +1679,7 @@ medusa.admin.orders }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### refundPayment +#### refundPayment Refund an amount for an order. The amount must be less than or equal the `refundable_amount` of the order. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -2147,7 +2147,7 @@ medusa.admin.orders }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### refundPayment +#### refundPayment Refund a payment. The payment must be captured first. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -283,7 +283,7 @@ medusa.admin.payments }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deletePrices +#### deletePrices Delete a list of prices in a price list -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -803,7 +803,7 @@ medusa.admin.priceLists }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a price list's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -2736,7 +2736,7 @@ medusa.admin.priceLists }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deleteOption +#### deleteOption Delete a product option. If there are product variants that use this product option, they must be deleted before deleting the product option. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve a product's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -3616,7 +3616,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### setMetadata +#### setMetadata Set the metadata of a product. It can be any key-value pair, which allows adding custom data to a product. Learn about how you can update and delete the metadata attribute [here](https://docs.medusajs.com/development/entities/overview#metadata-attribute). -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -4013,7 +4013,7 @@ medusa.admin.products }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deleteCountry +#### deleteCountry Delete a country from the list of countries in a region. The country will still be available in the system, and it can be used in other regions. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1265,7 +1265,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deleteFulfillmentProvider +#### deleteFulfillmentProvider Delete a fulfillment provider from a region. The fulfillment provider will still be available for usage in other regions. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1523,7 +1523,7 @@ medusa.admin.regions }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieveFulfillmentOptions +#### retrieveFulfillmentOptions Retrieve a list of fulfillment options available in a region. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -2735,7 +2735,7 @@ medusa.admin.regions }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a reservation's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -944,7 +944,7 @@ medusa.admin.reservations }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve a return reason's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -510,7 +510,7 @@ medusa.admin.returnReasons }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### list +#### list Retrieve a list of Returns. The returns can be paginated. -#### Example +##### Example To list returns: @@ -631,7 +631,7 @@ medusa.admin.returns }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve a shipping option's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -804,7 +804,7 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a shipping option's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1062,7 +1062,7 @@ medusa.admin.shippingOptions }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve a shipping profile's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -483,7 +483,7 @@ medusa.admin.shippingProfiles }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deleteCurrency +#### deleteCurrency Delete a currency code from the available currencies in a store. This doesn't completely delete the currency and it can be added again later to the store. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -234,7 +234,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### listPaymentProviders +#### listPaymentProviders Retrieve a list of available payment providers in a store. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -435,7 +435,7 @@ medusa.admin.store.listPaymentProviders().then(({ payment_providers }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### listTaxProviders +#### listTaxProviders Retrieve a list of available tax providers in a store. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -519,7 +519,7 @@ medusa.admin.store.listTaxProviders().then(({ tax_providers }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve the store's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -603,7 +603,7 @@ medusa.admin.store.retrieve().then(({ store }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update the store's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -835,7 +835,7 @@ medusa.admin.store }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### list +#### list Retrieve a list of tax rates. The tax rates can be filtered by fields such as `name` or `rate` passed in the `query` parameter. The tax rates can also be paginated. -#### Example +##### Example To list tax rates: @@ -1240,7 +1240,7 @@ medusa.admin.taxRates }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### createProtected +#### createProtected Upload a file to an ACL or a non-public bucket. The file upload is handled by the file service installed on the Medusa backend. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -149,7 +149,7 @@ medusa.admin.uploads.createProtected(file).then(({ uploads }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### delete +#### delete Delete an uploaded file from storage. The file is deleted using the installed file service on the Medusa backend. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -237,7 +237,7 @@ medusa.admin.uploads }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### list +#### list Retrieve all admin users. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -285,7 +285,7 @@ medusa.admin.users.list().then(({ users }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### resetPassword +#### resetPassword Reset the password of an admin user using their reset password token. You must generate a reset password token first for the user using the [sendResetPasswordToken](AdminUsersResource.mdx#sendresetpasswordtoken) method, then use that token to reset the password in this method. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -447,7 +447,7 @@ medusa.admin.users }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### sendResetPasswordToken +#### sendResetPasswordToken Generate a password token for an admin user with a given email. This also triggers the `user.password_reset` event. So, if you have a Notification Service installed that can handle this event, a notification, such as an email, will be sent to the user. The token is triggered as part of the `user.password_reset` event's payload. That token must be used later to reset the password using the [resetPassword](AdminUsersResource.mdx#resetpassword) method. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -814,7 +814,7 @@ medusa.admin.users }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### list +#### list Retrieve a list of product variants. The product variant can be filtered by fields such as `id` or `title` passed in the `query` parameter. The product variant can also be paginated. -#### Example +##### Example To list product variants: @@ -170,7 +170,7 @@ medusa.admin.variants }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### exists +#### exists Check if the email is already used by another registered customer. Can be used to validate a new customer's email. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -308,7 +308,7 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.auth.exists("user@example.com") ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### getToken +#### getToken Authenticate the customer and retrieve a JWT token to use for subsequent authenticated requests. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -588,7 +588,7 @@ medusa.auth }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### create +#### create Create a Cart. Although optional, specifying the cart's region and sales channel can affect the cart's pricing and the products that can be added to the cart respectively. So, make sure to set those early on and change them if necessary, such as when the customer changes their region. If a customer is logged in, make sure to pass its ID or email within the cart's details so that the cart is attached to the customer. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -571,7 +571,7 @@ medusa.carts.create().then(({ cart }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### createPaymentSessions +#### createPaymentSessions Create Payment Sessions for each of the available Payment Providers in the Cart's Region. If there's only one payment session created, it will be selected by default. The creation of the payment session uses the payment provider and may require sending requests to third-party services. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1062,7 +1062,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deleteDiscount +#### deleteDiscount Remove a Discount from a Cart. This only removes the application of the discount, and not completely deletes it. The totals will be re-calculated and the payment sessions will be refreshed after the removal. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1488,7 +1488,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### deletePaymentSession +#### deletePaymentSession Delete a Payment Session in a Cart. May be useful if a payment has failed. The totals will be recalculated. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1922,7 +1922,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### refreshPaymentSession +#### refreshPaymentSession Refresh a Payment Session to ensure that it is in sync with the Cart. This is usually not necessary, but is provided for edge cases. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -2356,7 +2356,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve a Cart's details. This includes recalculating its totals. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -2790,7 +2790,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### setPaymentSession +#### setPaymentSession Select the Payment Session that will be used to complete the cart. This is typically used when the customer chooses their preferred payment method during checkout. The totals of the cart will be recalculated. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -3220,7 +3220,7 @@ medusa.carts }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### resetPassword +#### resetPassword Reset a customer's password using a password token created by a previous request using the [generatePasswordToken](CustomersResource.mdx#generatepasswordtoken) method. If the password token expired, you must create a new one. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1467,7 +1467,7 @@ medusa.customers }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update the logged-in customer's details. This method requires [customer authentication](AuthResource.mdx#authenticate). -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1910,7 +1910,7 @@ medusa.customers }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### update +#### update Update a line item's data. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -931,7 +931,7 @@ medusa.carts.lineItems }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### decline +#### decline Decline an Order Edit. The changes are not reflected on the original order. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -330,7 +330,7 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve an Order Edit's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -648,7 +648,7 @@ medusa.orderEdits.retrieve(orderEditId).then(({ order_edit }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieveByCartId +#### retrieveByCartId Retrieve an order's details by the ID of the cart that was used to create the order. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1390,7 +1390,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### search +#### search Run a search query on products using the search service installed on the Medusa backend. The searching is handled through the search service, so the returned data's format depends on the search service you're using. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -1174,7 +1174,7 @@ medusa.products }) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve a Region's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -295,7 +295,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### retrieve +#### retrieve Retrieve a Return Reason's details. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -192,7 +192,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { ___ -### listCartOptions +#### listCartOptions Retrieve a list of shipping options available for a cart. -#### Example +##### Example ```ts import Medusa from "@medusajs/medusa-js" @@ -331,7 +331,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }) ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### cork +#### cork The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](../../internal/classes/internal.WritableBase.mdx#uncork) or [end](../../internal/classes/internal.WritableBase.mdx#end) methods are called. @@ -738,7 +748,7 @@ to be processed. However, use of `writable.cork()` without implementing`writable See also: `writable.uncork()`, `writable._writev()`. -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [Writable](internal.internal-3.Writable.mdx)` @@ -2117,7 +2137,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { See also: `writable.cork()`. -#### Returns +##### Returns { A `Writable` stream in object mode will always ignore the `encoding` argument. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (source, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)<B>` -#### Parameters +##### Parameters -#### Returns +##### Returns (source, transform1, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)<B>` -#### Parameters +##### Parameters -#### Returns +##### Returns (source, transform1, transform2, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)<B>` -#### Parameters +##### Parameters -#### Returns +##### Returns (source, transform1, transform2, transform3, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)<B>` -#### Parameters +##### Parameters -#### Returns +##### Returns (source, transform1, transform2, transform3, transform4, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)<B>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -### Type declaration +#### Type declaration ##### Parameters diff --git a/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineDestinationPromiseFunction.mdx b/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineDestinationPromiseFunction.mdx index 7d5bd105a6..ce51794a0d 100644 --- a/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineDestinationPromiseFunction.mdx +++ b/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineDestinationPromiseFunction.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PipelineDestinationPromiseFunction -### Type parameters +#### Type Parameters -### Type declaration +#### Type declaration ##### Parameters diff --git a/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelinePromise.mdx b/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelinePromise.mdx index 1a52abe246..bc80fe3cbe 100644 --- a/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelinePromise.mdx +++ b/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelinePromise.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PipelinePromise -### Type parameters +#### Type Parameters -### Type declaration +#### Type declaration ##### Returns diff --git a/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineTransform.mdx b/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineTransform.mdx index 4bd3f266ba..f1cbf9bec5 100644 --- a/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineTransform.mdx +++ b/www/apps/docs/content/references/js-client/internal-3/types/internal.internal-3.PipelineTransform.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PipelineTransform -### Type parameters +#### Type Parameters +#### eventToSubscribersMap ## Methods -### emit +#### emit `Abstract **emit**(eventName, data, options): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns (data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns `", - "optional": false, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } -]} /> +[ISearchService](../../SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx).[options](../../SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx#options) ## Methods -### addDocuments +#### addDocuments Used to index documents by the search engine provider -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + #### Since @@ -90,14 +100,14 @@ v14.8.0, v12.19.0 ___ -### emitDestroy +#### emitDestroy Call all `destroy` hooks. This should only ever be called once. An error will be thrown if it is called more than once. This **must** be manually called. If the resource is left to be collected by the GC then the `destroy` hooks will never be called. -#### Returns +##### Returns -#### Returns +##### Returns - + #### Since @@ -162,9 +182,9 @@ v9.6.0 ___ -### triggerAsyncId +#### triggerAsyncId -#### Returns +##### Returns -#### Returns +##### Returns - + #### Since diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Axios.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Axios.mdx index fbdfbdf535..1f0eea35c3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Axios.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Axios.mdx @@ -49,9 +49,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### delete +#### delete -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### cork +#### cork The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](internal.WritableBase.mdx#uncork) or [end](internal.WritableBase.mdx#end) methods are called. @@ -1153,7 +1163,7 @@ to be processed. However, use of `writable.cork()` without implementing`writable See also: `writable.uncork()`, `writable._writev()`. -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, options?): Promise<undefined \| T>` @@ -2003,7 +2013,7 @@ to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value. If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { The `readable.pause()` method has no effect if there is a `'readable'`event listener. -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [Duplex](internal.Duplex.mdx)` @@ -3594,7 +3614,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, initial?, options?): Promise<T>` @@ -4780,7 +4800,7 @@ If the stream is empty, the promise is rejected with a `TypeError` with the `ERR The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method. -#### Parameters +##### Parameters -#### Returns +##### Returns (fn, initial, options?): Promise<T>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { See also: `writable.cork()`. -#### Returns +##### Returns { }, 1000); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { A `Writable` stream in object mode will always ignore the `encoding` argument. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### cork +#### cork The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](internal.WritableBase.mdx#uncork) or [end](internal.WritableBase.mdx#end) methods are called. @@ -1222,7 +1232,7 @@ to be processed. However, use of `writable.cork()` without implementing`writable See also: `writable.uncork()`, `writable._writev()`. -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, options?): Promise<undefined \| T>` @@ -2072,7 +2082,7 @@ to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value. If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { The `readable.pause()` method has no effect if there is a `'readable'`event listener. -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [PassThrough](internal.PassThrough.mdx)` @@ -3663,7 +3683,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, initial?, options?): Promise<T>` @@ -4849,7 +4869,7 @@ If the stream is empty, the promise is rejected with a `TypeError` with the `ERR The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method. -#### Parameters +##### Parameters -#### Returns +##### Returns (fn, initial, options?): Promise<T>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { See also: `writable.cork()`. -#### Returns +##### Returns { }, 1000); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { A `Writable` stream in object mode will always ignore the `encoding` argument. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### destroy +#### destroy Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -773,7 +783,7 @@ further errors except from `_destroy()` may be emitted as `'error'`. Implementors should not override this method, but instead implement `readable._destroy()`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, options?): Promise<undefined \| T>` @@ -1314,7 +1324,7 @@ to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value. If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { The `readable.pause()` method has no effect if there is a `'readable'`event listener. -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [Readable](internal.Readable.mdx)` @@ -2593,7 +2613,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, initial?, options?): Promise<T>` @@ -3467,7 +3487,7 @@ If the stream is empty, the promise is rejected with a `TypeError` with the `ERR The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method. -#### Parameters +##### Parameters -#### Returns +##### Returns (fn, initial, options?): Promise<T>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }, 1000); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### destroy +#### destroy Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -788,7 +798,7 @@ further errors except from `_destroy()` may be emitted as `'error'`. Implementors should not override this method, but instead implement `readable._destroy()`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, options?): Promise<undefined \| T>` @@ -1329,7 +1339,7 @@ to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value. If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { The `readable.pause()` method has no effect if there is a `'readable'`event listener. -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [ReadableBase](internal.ReadableBase.mdx)` @@ -2608,7 +2628,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, initial?, options?): Promise<T>` @@ -3482,7 +3502,7 @@ If the stream is empty, the promise is rejected with a `TypeError` with the `ERR The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method. -#### Parameters +##### Parameters -#### Returns +##### Returns (fn, initial, options?): Promise<T>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }, 1000); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### connect +#### connect `**connect**(options, connectionListener?): [Socket](internal.Socket.mdx)` @@ -1231,7 +1241,7 @@ for the `'connect'` event **once**. This function should only be used for reconnecting a socket after`'close'` has been emitted or otherwise it may lead to undefined behavior. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, options?): Promise<undefined \| T>` @@ -2241,7 +2251,7 @@ to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value. If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [Socket](internal.Socket.mdx)` @@ -3656,7 +3676,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, initial?, options?): Promise<T>` @@ -4686,7 +4706,7 @@ If the stream is empty, the promise is rejected with a `TypeError` with the `ERR The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method. -#### Parameters +##### Parameters -#### Returns +##### Returns (fn, initial, options?): Promise<T>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { See also: `writable.cork()`. -#### Returns +##### Returns { }, 1000); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### emit +#### emit Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -241,7 +251,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); // event with parameters 1, 2, 3, 4, 5 in third listener ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener Adds the `listener` function to the \_beginning\_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -687,7 +707,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### cork +#### cork The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](internal.WritableBase.mdx#uncork) or [end](internal.WritableBase.mdx#end) methods are called. @@ -1232,7 +1242,7 @@ to be processed. However, use of `writable.cork()` without implementing`writable See also: `writable.uncork()`, `writable._writev()`. -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, options?): Promise<undefined \| T>` @@ -2082,7 +2092,7 @@ to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value. If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { The `readable.pause()` method has no effect if there is a `'readable'`event listener. -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [Transform](internal.Transform.mdx)` @@ -3673,7 +3693,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, initial?, options?): Promise<T>` @@ -4859,7 +4879,7 @@ If the stream is empty, the promise is rejected with a `TypeError` with the `ERR The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method. -#### Parameters +##### Parameters -#### Returns +##### Returns (fn, initial, options?): Promise<T>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { See also: `writable.cork()`. -#### Returns +##### Returns { }, 1000); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns { A `Writable` stream in object mode will always ignore the `encoding` argument. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### cork +#### cork The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](internal.WritableBase.mdx#uncork) or [end](internal.WritableBase.mdx#end) methods are called. @@ -753,7 +763,7 @@ to be processed. However, use of `writable.cork()` without implementing`writable See also: `writable.uncork()`, `writable._writev()`. -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [WritableBase](internal.WritableBase.mdx)` @@ -2132,7 +2152,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { See also: `writable.cork()`. -#### Returns +##### Returns { A `Writable` stream in object mode will always ignore the `encoding` argument. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### emit +#### emit Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -241,7 +251,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); // event with parameters 1, 2, 3, 4, 5 in third listener ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener Adds the `listener` function to the \_beginning\_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -687,7 +707,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ac.abort()); ``` -#### Parameters +##### Parameters ac.abort()); } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[IBatchJobStrategy](../interfaces/internal.internal.IBatchJobStrategy.mdx).[activeManager_](../interfaces/internal.internal.IBatchJobStrategy.mdx#activemanager_) + +#### Inherited from + +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[IFileService](../interfaces/internal.internal.IFileService.mdx).[activeManager_](../interfaces/internal.internal.IFileService.mdx#activemanager_) + +#### Inherited from + +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[INotificationService](../interfaces/internal.internal.INotificationService.mdx).[activeManager_](../interfaces/internal.internal.INotificationService.mdx#activemanager_) + +#### Inherited from + +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[PaymentService](../interfaces/internal.internal.PaymentService.mdx).[activeManager_](../interfaces/internal.internal.PaymentService.mdx#activemanager_) + +#### Inherited from + +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addLineItem +#### addLineItem Adds a line item to the cart. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addCustomers +#### addCustomers Add a batch of customers to a customer group at once -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addAddress +#### addAddress -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addRegion +#### addRegion Adds a region to the discount regions array. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### withTransaction +#### withTransaction -#### Parameters +##### Parameters -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ___ -### eventBusModuleService\_ - -#### Returns - - +#### eventBusModuleService\_ ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns (data): Promise<void \| [StagedJob](internal.internal.StagedJob.mdx)[]>` Calls all subscribers when an event occurs. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ___ -### inventoryService\_ - -#### Returns - - +#### inventoryService\_ ## Methods -### addLineItem +#### addLineItem -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addShippingMethod +#### addShippingMethod -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ___ -### paymentService\_ - -#### Returns - - +#### paymentService\_ ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addCurrencyFromRegion +#### addCurrencyFromRegion Add `currency_code` to an MA record if `region_id`is passed. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ___ -### pricingModuleService - -#### Returns - - Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "addPrices", - "type": "(`data`: [AddPricesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPricesDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>(`data`: [AddPricesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPricesDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "addRules", - "type": "(`data`: [AddRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddRulesDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>(`data`: [AddRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddRulesDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "calculatePrices", - "type": "(`filters`: [PricingFilters](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PricingFilters.mdx), `context?`: [PricingContext](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PricingContext.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[CalculatedPriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSetDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "create", - "type": "(`data`: [CreatePriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>(`data`: [CreatePriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createCurrencies", - "type": "(`data`: [CreateCurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createMoneyAmounts", - "type": "(`data`: [CreateMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateMoneyAmountDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceListRules", - "type": "(`data`: [CreatePriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceLists", - "type": "(`data`: [CreatePriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceRules", - "type": "(`data`: [CreatePriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceSetMoneyAmountRules", - "type": "(`data`: [CreatePriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountRulesDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createRuleTypes", - "type": "(`data`: [CreateRuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateRuleTypeDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "delete", - "type": "(`ids`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteCurrencies", - "type": "(`currencyCodes`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteMoneyAmounts", - "type": "(`ids`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceListRules", - "type": "(`priceListRuleIds`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceLists", - "type": "(`priceListIds`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceRules", - "type": "(`priceRuleIds`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceSetMoneyAmountRules", - "type": "(`ids`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteRuleTypes", - "type": "(`ruleTypeIds`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "list", - "type": "(`filters?`: [FilterablePriceSetProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCount", - "type": "(`filters?`: [FilterablePriceSetProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountCurrencies", - "type": "(`filters?`: [FilterableCurrencyProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountMoneyAmounts", - "type": "(`filters?`: [FilterableMoneyAmountProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceListRules", - "type": "(`filters?`: [FilterablePriceListRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceLists", - "type": "(`filters?`: [FilterablePriceListProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceRules", - "type": "(`filters?`: [FilterablePriceRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceSetMoneyAmountRules", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountRulesProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceSetMoneyAmounts", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceSetMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountRuleTypes", - "type": "(`filters?`: [FilterableRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listCurrencies", - "type": "(`filters?`: [FilterableCurrencyProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listMoneyAmounts", - "type": "(`filters?`: [FilterableMoneyAmountProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceListRules", - "type": "(`filters?`: [FilterablePriceListRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceLists", - "type": "(`filters?`: [FilterablePriceListProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceRules", - "type": "(`filters?`: [FilterablePriceRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceSetMoneyAmountRules", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountRulesProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceSetMoneyAmounts", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listRuleTypes", - "type": "(`filters?`: [FilterableRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "removePriceListRules", - "type": "(`data`: [RemovePriceListRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceListRulesDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "removeRules", - "type": "(`data`: [RemovePriceSetRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceSetRulesDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveCurrency", - "type": "(`code`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveMoneyAmount", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceList", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceListRule", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceRule", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceSetMoneyAmountRules", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveRuleType", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "setPriceListRules", - "type": "(`data`: [SetPriceListRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.SetPriceListRulesDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateCurrencies", - "type": "(`data`: [UpdateCurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateCurrencyDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateMoneyAmounts", - "type": "(`data`: [UpdateMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateMoneyAmountDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceListRules", - "type": "(`data`: [UpdatePriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceLists", - "type": "(`data`: [UpdatePriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceRules", - "type": "(`data`: [UpdatePriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceSetMoneyAmountRules", - "type": "(`data`: [UpdatePriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceSetMoneyAmountRulesDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateRuleTypes", - "type": "(`data`: [UpdateRuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateRuleTypeDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> +#### pricingModuleService ___ -### remoteQuery - -#### Returns - -`) => Promise<any> \\| `null`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> +#### remoteQuery ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addProducts +#### addProducts Add a batch of product to a product category -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addProducts +#### addProducts -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addOption +#### addOption Adds an option to a product. Options can, for example, be "Size", "Color", etc. Will update all the products variants with a dummy value for the newly created option. The same option cannot be added more than once. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ___ -### inventoryService\_ - -#### Returns - - Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<boolean>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/internal.Partial.mdx)<[CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevels", - "type": "(`updates`: [BulkUpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> +#### inventoryService\_ ___ -### stockLocationService\_ - -#### Returns - - Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> +#### stockLocationService\_ ## Methods -### adjustInventory +#### adjustInventory Adjusts inventory of a variant on a location -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addOptionValue +#### addOptionValue Adds option value to a variant. Fails when product with variant does not exist or @@ -192,7 +182,7 @@ if that product does not have an option with the given option id. Fails if given variant is not found. Option value must be of type string or number. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addCountry +#### addCountry Adds a country to the region. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ___ -### inventoryService\_ - -#### Returns - - Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<boolean>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/internal.Partial.mdx)<[CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevels", - "type": "(`updates`: [BulkUpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> +#### inventoryService\_ ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ___ -### stockLocationService\_ - -#### Returns - - Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> +#### stockLocationService\_ ## Methods -### associateLocation +#### associateLocation Associates a sales channel with a stock location. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addProducts +#### addProducts Add a batch of product to a sales channel -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns `", - "optional": false, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } -]} /> +[AbstractSearchService](internal.AbstractSearchService.mdx).[options](internal.AbstractSearchService.mdx#options) ## Methods -### addDocuments +#### addDocuments Used to index documents by the search engine provider -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addRequirement +#### addRequirement Adds a requirement to a shipping option. Only 1 requirement of each type is allowed. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addProduct +#### addProduct -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addCurrency +#### addCurrency Add a currency to the store -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### areReturnItemsValid +#### areReturnItemsValid -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### addToProduct +#### addToProduct -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +#### activeManager\_ ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](internal.internal.TransactionBaseService.mdx).[activeManager_](internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns + ___ -### getFreshManager +#### getFreshManager -#### Returns +##### Returns - + ___ -### serialize +#### serialize -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns target.byteLength`, or `sourceEnd > source.byteLength`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### reduceRight +#### reduceRight `**reduceRight**(callbackfn): number` @@ -2872,7 +2882,7 @@ Calls the specified callback function for all the elements in an array, in desce The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### reverse +#### reverse -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ``` -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { A `TypeError` will be thrown if `size` is not a number. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterable.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterable.mdx index 700056e7dc..4036bfaed0 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterable.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterable.mdx @@ -22,9 +22,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### [iterator] +#### [iterator] -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener Adds the `listener` function to the \_beginning\_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -789,7 +799,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener Adds the `listener` function to the \_beginning\_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -659,7 +669,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns { Returns a reference to the `EventEmitter`, so that calls can be chained. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### destroy +#### destroy Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`is provided, an `'error'` event is emitted on the socket and `error` is passed as an argument to any listeners on the event. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, options?): Promise<undefined \| T>` @@ -1452,7 +1462,7 @@ to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value. If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { The `readable.pause()` method has no effect if there is a `'readable'`event listener. -#### Returns +##### Returns -#### Returns +##### Returns - + ___ -### prependListener +#### prependListener `**prependListener**(event, listener): [MedusaRequest](internal.internal.MedusaRequest.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns (fn, initial?, options?): Promise<T>` @@ -3513,7 +3533,7 @@ If the stream is empty, the promise is rejected with a `TypeError` with the `ERR The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method. -#### Parameters +##### Parameters -#### Returns +##### Returns (fn, initial, options?): Promise<T>` -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns { }, 1000); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns { }); ``` -#### Parameters +##### Parameters { } ]} /> -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns +[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_) ## Methods -### atomicPhase\_ +#### atomicPhase\_ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. -#### Parameters +##### Parameters -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns -#### Returns +##### Returns ___ -### defaultAdminProductFields +#### defaultAdminProductCategoryRelations ___ -### defaultAdminProductRelations +#### defaultAdminProductFields ___ -### defaultAdminProductRemoteQueryObject +#### defaultAdminProductRelations + +___ + +#### defaultAdminProductRemoteQueryObject This is temporary. -### Type declaration +#### Type declaration -### Index signature +#### Index signature ▪ [k: `string`]: `T` diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.Discount-5.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.Discount-5.mdx index c9c3a20eac..38c0954ab8 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.Discount-5.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.Discount-5.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" A discount can be applied to a cart for promotional purposes. -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration ##### Parameters @@ -38,4 +38,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ##### Returns - + diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.internal.Constructor.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.internal.Constructor.mdx index 2d21fde7ee..d392f67292 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.internal.Constructor.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.internal.Constructor.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Constructor -### Type parameters +#### Type Parameters -### Type declaration +#### Type declaration ##### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.internal.CreateBatchJobInput.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.internal.CreateBatchJobInput.mdx index 580ad4a648..fb688e6d32 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.internal.CreateBatchJobInput.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.internal.CreateBatchJobInput.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreateBatchJobInput -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -### Type declaration +#### Type declaration -#### Returns +##### Returns -#### Returns +##### Returns diff --git a/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx deleted file mode 100644 index c9dd954d50..0000000000 --- a/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -displayed_sidebar: pricingReference ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CalculatedPriceSetDTO - -A calculated price set's data. - -## Properties - - diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx index 3bf7d28d57..2d69f84d2c 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx @@ -7,4 +7,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreatePriceListRules The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value - * is the values of the rule. +is the values of the rule. diff --git a/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx b/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx index eaa4323bd3..77fe2ecda9 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FindConfig -An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class, +An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class, which provides correct typing of field names in its properties. ## Type parameters @@ -33,17 +33,7 @@ which provides correct typing of field names in its properties. "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -65,7 +55,7 @@ which provides correct typing of field names in its properties. }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -74,7 +64,7 @@ which provides correct typing of field names in its properties. }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx index a4266fb7a6..84e917ff68 100644 --- a/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx @@ -108,7 +108,7 @@ A money amount's data. A money amount represents a price. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [ { "name": "id", @@ -187,7 +187,7 @@ A money amount's data. A money amount represents a price. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ] diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx index 77b4938ac1..ba3cb05dfa 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx @@ -134,7 +134,7 @@ A price list's details. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [ { "name": "id", @@ -517,7 +517,7 @@ A price list's details. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ] diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx index b5fa0c7508..0f0c92aa3f 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx @@ -114,7 +114,7 @@ The price list rule's details. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ] diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx index 303cbf68b8..8d084bbc39 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx @@ -114,7 +114,7 @@ A price rule's data. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ] diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx index f3aba2f4f7..7aa485d1f3 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx @@ -125,7 +125,7 @@ A price set's data. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [ { "name": "id", diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx index 9a1727e76f..a540b5a808 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx @@ -125,7 +125,7 @@ A price set money amount's data. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [ { "name": "id", @@ -288,7 +288,7 @@ A price set money amount's data. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ] @@ -820,7 +820,7 @@ A price set money amount's data. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ] diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx index 2b6b3b9d61..8d4bd83602 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx @@ -105,7 +105,7 @@ A price set money amount rule's data. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ] diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx index fdecc4743d..ac4097da5a 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx @@ -13,7 +13,7 @@ The attributes to update in a price list. `: `T` extends `U` ? `never` : `T` + **Exclude**: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U -### Type parameters +#### Type Parameters `: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> + **Omit**: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> Construct a type with the properties of T except for those in type K. -### Type parameters +#### Type Parameters `: { [P in K]: T[P] } + **Pick**: { [P in K]: T[P] } From T, pick a set of properties whose keys are in the union K -### Type parameters +#### Type Parameters `: { [P in K]: T } + **Record**: { [P in K]: T } Construct a type with a set of properties K of type T -### Type parameters +#### Type Parameters `unknown`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "thisArg", diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.filter.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.filter.mdx index fb873c56c5..b163cab9b2 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.filter.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.filter.mdx @@ -22,17 +22,7 @@ Returns the elements of an array that meet the condition specified in a callback "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `any`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "thisArg", diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.find.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.find.mdx index f02805f81b..566e77c787 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.find.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.find.mdx @@ -23,17 +23,7 @@ otherwise. "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`value`: `number`, `index`: `number`, `obj`: Uint8Array) => `boolean`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "thisArg", diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.findIndex.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.findIndex.mdx index 7657b84057..d3d1442b3b 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.findIndex.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.findIndex.mdx @@ -23,17 +23,7 @@ otherwise. "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`value`: `number`, `index`: `number`, `obj`: Uint8Array) => `boolean`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "thisArg", diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.forEach.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.forEach.mdx index 7ab2666b36..769ae6584e 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.forEach.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.forEach.mdx @@ -22,17 +22,7 @@ Performs the specified action for each element in an array. "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "thisArg", diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.map.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.map.mdx index 50ceaef898..fa902d4a5e 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.map.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.map.mdx @@ -23,17 +23,7 @@ contains the results. "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `number`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "thisArg", diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduce.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduce.mdx index 798f4e5b5b..b715250899 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduce.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduce.mdx @@ -24,17 +24,7 @@ call to the callback function. "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] } ]} /> @@ -70,17 +60,7 @@ Uint8Array.reduce "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "initialValue", @@ -119,6 +99,8 @@ Calls the specified callback function for all the elements in an array. The retu the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. +#### Type Parameters + `U`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "initialValue", @@ -168,7 +140,17 @@ call to the callback function. `U` - + #### Inherited from diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduceRight.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduceRight.mdx index 6ae4e3df97..8dae04b920 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduceRight.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.reduceRight.mdx @@ -24,17 +24,7 @@ argument in the next call to the callback function. "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] } ]} /> @@ -70,17 +60,7 @@ Uint8Array.reduceRight "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "initialValue", @@ -119,6 +99,8 @@ Calls the specified callback function for all the elements in an array, in desce The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. +#### Type Parameters + `U`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "initialValue", @@ -168,7 +140,17 @@ argument in the next call to the callback function. `U` - + #### Inherited from diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.some.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.some.mdx index 2ac69e2686..d707df5074 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.some.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.some.mdx @@ -22,17 +22,7 @@ Determines whether the specified callback function returns true for any element "optional": false, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `unknown`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "thisArg", diff --git a/www/apps/docs/content/references/product/Buffer/methods/Buffer.sort.mdx b/www/apps/docs/content/references/product/Buffer/methods/Buffer.sort.mdx index 920eca6904..cc99f0c53b 100644 --- a/www/apps/docs/content/references/product/Buffer/methods/Buffer.sort.mdx +++ b/www/apps/docs/content/references/product/Buffer/methods/Buffer.sort.mdx @@ -22,17 +22,7 @@ Sorts an array. "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "(`a`: `number`, `b`: `number`) => `number`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] } ]} /> diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.create.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.create.mdx index 151c09d87d..623080eaae 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.create.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.create.mdx @@ -18,7 +18,7 @@ This method is used to create a product. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -473,6 +473,15 @@ async function createProduct (title: string) { "expandable": false, "children": [] }, + { + "name": "product_id", + "type": "`string`", + "description": "The id of the product", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "sku", "type": "`string`", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx index 58a42e7dfc..eb3a88fe87 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx @@ -18,7 +18,7 @@ This method is used to create a product category. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx index 20557f71f0..d6a393ffe7 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx @@ -18,7 +18,7 @@ This method is used to create product collections. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx index 0e8aa07ec9..2f57b4dbf3 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx @@ -18,7 +18,7 @@ This method is used to create product options. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx index 557f980b4e..ebafe63b86 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx @@ -18,7 +18,7 @@ This method is used to create product tags. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx index 66c1ff8a2b..216f9d6706 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx @@ -18,7 +18,7 @@ This method is used to create a product type. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createVariants.mdx new file mode 100644 index 0000000000..ee6da6f8a3 --- /dev/null +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createVariants.mdx @@ -0,0 +1,545 @@ +--- +displayed_sidebar: productReference +badge: + variant: orange + text: Beta +slug: /references/product/createVariants +sidebar_label: createVariants +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# createVariants - Product Module Reference + +This documentation provides a reference to the createVariants method. This belongs to the Product Module. + +This method is used to create variants for a product. + +## Example + +```ts +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 +} +``` + +## Parameters + +`", + "description": "Holds custom data in key-value pairs.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "The MID Code of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "options", + "type": "[CreateProductVariantOptionDTO](../../interfaces/CreateProductVariantOptionDTO.mdx)[]", + "description": "The product variant options to create and associate with the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [ + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of a product variant option.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "The origin country of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "The id of the product", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "The SKU of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The tile of the product variant.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "The UPC of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "The weight of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "The width of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[Context](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "A boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "isolationLevel", + "type": "`string`", + "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "A string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + } +]} /> + +## Returns + +`", + "description": "Holds custom data in key-value pairs.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "mid_code", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "options", + "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", + "description": "The associated product options.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "origin_country", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "product", + "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", + "description": "The associated product.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "The ID of the associated product.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "sku", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The tile of the product variant.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "upc", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "updated_at", + "type": "`string` \\| `Date`", + "description": "When the product variant was updated.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "variant_rank", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "weight", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "width", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx index 38e85c00e2..3616085401 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx @@ -18,7 +18,7 @@ This method is used to delete products. Unlike the [softDelete](IProductModuleSe ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx index 1194c7fe14..004f80ef17 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx @@ -18,7 +18,7 @@ This method is used to delete a product category by its ID. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx index bfc59e1a55..1ab5f32cca 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx @@ -18,7 +18,7 @@ This method is used to delete collections by their ID. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx index 6845cb008b..b1de5d4e03 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx @@ -18,7 +18,7 @@ This method is used to delete a product option. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx index 7131d42038..781e0e69b1 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx @@ -18,7 +18,7 @@ This method is used to delete product tags by their ID. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx index 9a3289718f..315d282d4b 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx @@ -18,7 +18,7 @@ This method is used to delete a product type. ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteVariants.mdx new file mode 100644 index 0000000000..8f16e41845 --- /dev/null +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteVariants.mdx @@ -0,0 +1,113 @@ +--- +displayed_sidebar: productReference +badge: + variant: orange + text: Beta +slug: /references/product/deleteVariants +sidebar_label: deleteVariants +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# deleteVariants - Product Module Reference + +This documentation provides a reference to the deleteVariants method. This belongs to the Product Module. + +This method is used to delete ProductVariant. This method will completely remove the ProductVariant and they can no longer be accessed or retrieved. + +## Example + +```ts +import { + initialize as initializeProductModule, +} from "@medusajs/product" + +async function deleteProducts (ids: string[]) { + const productModule = await initializeProductModule() + + await productModule.deleteVariants(ids) +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx index cd4618b2c6..b322264dc7 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price sets based on optional To retrieve a list of products using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProducts (ids: string[]) { To specify relations that should be retrieved within the products: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProducts (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -69,7 +69,7 @@ async function retrieveProducts (ids: string[], skip: number, take: number) { id: ids }, { relations: ["categories"], - skip, + skip, take }) @@ -80,7 +80,7 @@ async function retrieveProducts (ids: string[], skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -98,7 +98,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak ] }, { relations: ["categories"], - skip, + skip, take }) @@ -184,7 +184,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "collection_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "Filters a product by the IDs of their associated collections.", + "description": "Filters a product by its associated collections.", "optional": true, "defaultValue": "", "expandable": false, @@ -253,17 +253,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -285,7 +275,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -294,7 +284,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx index 0987a7ba2f..f90311941f 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of products along with the tota To retrieve a list of products using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProducts (ids: string[]) { To specify relations that should be retrieved within the products: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProducts (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -69,7 +69,7 @@ async function retrieveProducts (ids: string[], skip: number, take: number) { id: ids }, { relations: ["categories"], - skip, + skip, take }) @@ -80,7 +80,7 @@ async function retrieveProducts (ids: string[], skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -98,7 +98,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak ] }, { relations: ["categories"], - skip, + skip, take }) @@ -184,7 +184,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "collection_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "Filters a product by the IDs of their associated collections.", + "description": "Filters a product by its associated collections.", "optional": true, "defaultValue": "", "expandable": false, @@ -253,17 +253,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -285,7 +275,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -294,7 +284,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx index 87156c89ed..b2b87290d2 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product categories along wit To retrieve a list of product categories using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveCategories (ids: string[]) { To specify relations that should be retrieved within the product categories: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveCategories (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveCategories (ids: string[], skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -215,17 +215,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -247,7 +237,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -256,7 +246,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx index 478852819d..8790de4bf9 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product collections along wi To retrieve a list of product collections using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveCollections (ids: string[]) { To specify relations that should be retrieved within the product collections: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveCollections (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveCollections (ids: string[], skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -179,17 +179,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -211,7 +201,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -220,7 +210,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx index 75bf9ee2d2..2b5215e0a9 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product options along with t To retrieve a list of product options using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductOptions (ids: string[]) { To specify relations that should be retrieved within the product types: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductOptions (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductOptions (ids: string[], skip: number, take: number You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -179,17 +179,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -211,7 +201,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -220,7 +210,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx index b234c2a78e..d624e32cc2 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product tags along with the To retrieve a list of product tags using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductTag (tagIds: string[]) { To specify relations that should be retrieved within the product tags: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductTag (tagIds: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductTag (tagIds: string[], skip: number, take: number) You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -170,17 +170,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -202,7 +192,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -211,7 +201,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx index 11dfe4a76e..29d86e8eee 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product types along with the To retrieve a list of product types using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductTypes (ids: string[]) { To specify attributes that should be retrieved within the product types: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductTypes (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductTypes (ids: string[], skip: number, take: number) You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -170,17 +170,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -202,7 +192,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -211,7 +201,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx index 23fe2c3485..dc221878b9 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product variants along with To retrieve a list of product variants using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductVariants (ids: string[]) { To specify relations that should be retrieved within the product variants: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductVariants (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductVariants (ids: string[], skip: number, take: numbe You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -198,17 +198,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -230,7 +220,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -239,7 +229,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx index 8ba796567b..f89b0a8ae6 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product categories based on To retrieve a list of product categories using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveCategories (ids: string[]) { To specify relations that should be retrieved within the product categories: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveCategories (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveCategories (ids: string[], skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -215,17 +215,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -247,7 +237,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -256,7 +246,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx index 5bee9ef4c4..9fd169ee64 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product collections based on To retrieve a list of product collections using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveCollections (ids: string[]) { To specify relations that should be retrieved within the product collections: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveCollections (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveCollections (ids: string[], skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -179,17 +179,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -211,7 +201,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -220,7 +210,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx index ba0cf9672e..7169285d9a 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product options based on opt To retrieve a list of product options using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductOptions (ids: string[]) { To specify relations that should be retrieved within the product types: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductOptions (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductOptions (ids: string[], skip: number, take: number You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -179,17 +179,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -211,7 +201,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -220,7 +210,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx index 17b2b7529e..f0fc646d64 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of tags based on optional filte To retrieve a list of product tags using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductTag (tagIds: string[]) { To specify relations that should be retrieved within the product tags: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductTag (tagIds: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductTag (tagIds: string[], skip: number, take: number) You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -170,17 +170,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -202,7 +192,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -211,7 +201,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx index b31f7332f2..842253ba39 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product types based on optio To retrieve a list of product types using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductTypes (ids: string[]) { To specify attributes that should be retrieved within the product types: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductTypes (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductTypes (ids: string[], skip: number, take: number) You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -170,17 +170,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -202,7 +192,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -211,7 +201,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx index 7af1e5320c..f93980a68e 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of product variants based on op To retrieve a list of product variants using their IDs: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -38,7 +38,7 @@ async function retrieveProductVariants (ids: string[]) { To specify relations that should be retrieved within the product variants: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -58,7 +58,7 @@ async function retrieveProductVariants (ids: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -80,7 +80,7 @@ async function retrieveProductVariants (ids: string[], skip: number, take: numbe You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -198,17 +198,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number "optional": true, "defaultValue": "", "expandable": false, - "children": [ - { - "name": "__type", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] + "children": [] }, { "name": "relations", @@ -230,7 +220,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -239,7 +229,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", @@ -461,7 +451,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "options", - "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)", + "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", "description": "The associated product options.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx index ad048e28e8..cd0027ffab 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx @@ -18,7 +18,7 @@ This method is used to restore products which were deleted using the [softDelete ## Example ```ts -import { +import { initialize as initializeProductModule, } from "@medusajs/product" @@ -48,7 +48,7 @@ async function restoreProducts (ids: string[]) { { "name": "config", "type": "[RestoreReturn](../../interfaces/RestoreReturn.mdx)<TReturnableLinkableKeys>", - "description": "Configurations determining which relations to restore along with the each of the products. You can pass to its `returnLinkableKeys` property any of the product's relation attribute names, such as `variant_id`.", + "description": "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`.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx index 19df3e140c..8c57b41728 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx @@ -13,13 +13,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes" This documentation provides a reference to the restoreVariants method. This belongs to the Product Module. +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 [update](IProductModuleService.update.mdx) method. + +## Example + +```ts +import { + initialize as initializeProductModule, +} from "@medusajs/product" + +async function restoreProductVariants (ids: string[]) { + const productModule = await initializeProductModule() + + await productModule.restoreVariants(ids) +} +``` + ## Parameters `", + "description": "Holds custom data in key-value pairs.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "The MID Code of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "options", + "type": "[CreateProductVariantOptionDTO](../../interfaces/CreateProductVariantOptionDTO.mdx)[]", + "description": "The product variant options to create and associate with the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [ + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of a product variant option.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "The origin country of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "The SKU of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The tile of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "The UPC of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "The weight of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "The width of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[Context](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "A boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "isolationLevel", + "type": "`string`", + "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "A string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + } +]} /> + +## Returns + +`", + "description": "Holds custom data in key-value pairs.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "mid_code", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "options", + "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", + "description": "The associated product options.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "origin_country", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "product", + "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", + "description": "The associated product.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "The ID of the associated product.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "sku", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The tile of the product variant.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "upc", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "updated_at", + "type": "`string` \\| `Date`", + "description": "When the product variant was updated.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "variant_rank", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "weight", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "width", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator._iterator_.mdx b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator._iterator_.mdx index 0e2d34286c..e94161d08a 100644 --- a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator._iterator_.mdx +++ b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator._iterator_.mdx @@ -22,6 +22,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "defaultValue": "", "description": "", "expandable": false, - "children": [] + "children": [ + { + "name": "T", + "type": "`T`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + } + ] } ]} /> diff --git a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.next.mdx b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.next.mdx index 4c2ba8d61e..fd0353056f 100644 --- a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.next.mdx +++ b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.next.mdx @@ -37,6 +37,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "description": "", "expandable": false, "children": [ + { + "name": "T", + "type": "`T`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + }, { "name": "any", "type": "`any`", diff --git a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.return.mdx b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.return.mdx index d9fee6de4c..dd0702fefe 100644 --- a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.return.mdx +++ b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.return.mdx @@ -37,6 +37,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "description": "", "expandable": false, "children": [ + { + "name": "T", + "type": "`T`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + }, { "name": "any", "type": "`any`", diff --git a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.throw.mdx b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.throw.mdx index d709996322..13fbc83482 100644 --- a/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.throw.mdx +++ b/www/apps/docs/content/references/product/IterableIterator/methods/IterableIterator.throw.mdx @@ -37,6 +37,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "description": "", "expandable": false, "children": [ + { + "name": "T", + "type": "`T`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + }, { "name": "any", "type": "`any`", diff --git a/www/apps/docs/content/references/product/Iterator/methods/Iterator.next.mdx b/www/apps/docs/content/references/product/Iterator/methods/Iterator.next.mdx index 50be39e5ed..9a94ad8053 100644 --- a/www/apps/docs/content/references/product/Iterator/methods/Iterator.next.mdx +++ b/www/apps/docs/content/references/product/Iterator/methods/Iterator.next.mdx @@ -36,6 +36,25 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "defaultValue": "", "description": "", "expandable": false, - "children": [] + "children": [ + { + "name": "T", + "type": "`T`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + }, + { + "name": "TReturn", + "type": "`TReturn`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + } + ] } ]} /> diff --git a/www/apps/docs/content/references/product/Iterator/methods/Iterator.return.mdx b/www/apps/docs/content/references/product/Iterator/methods/Iterator.return.mdx index 7a4babeeca..7be6d6fb79 100644 --- a/www/apps/docs/content/references/product/Iterator/methods/Iterator.return.mdx +++ b/www/apps/docs/content/references/product/Iterator/methods/Iterator.return.mdx @@ -36,6 +36,25 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "defaultValue": "", "description": "", "expandable": false, - "children": [] + "children": [ + { + "name": "T", + "type": "`T`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + }, + { + "name": "TReturn", + "type": "`TReturn`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + } + ] } ]} /> diff --git a/www/apps/docs/content/references/product/Iterator/methods/Iterator.throw.mdx b/www/apps/docs/content/references/product/Iterator/methods/Iterator.throw.mdx index 1ca173f0d0..470ac06465 100644 --- a/www/apps/docs/content/references/product/Iterator/methods/Iterator.throw.mdx +++ b/www/apps/docs/content/references/product/Iterator/methods/Iterator.throw.mdx @@ -36,6 +36,25 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "defaultValue": "", "description": "", "expandable": false, - "children": [] + "children": [ + { + "name": "T", + "type": "`T`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + }, + { + "name": "TReturn", + "type": "`TReturn`", + "optional": false, + "defaultValue": "", + "description": "", + "expandable": false, + "children": [] + } + ] } ]} /> diff --git a/www/apps/docs/content/references/product/enums/ProductStatus.mdx b/www/apps/docs/content/references/product/enums/ProductStatus.mdx index 42a74208d7..63dccf4ed7 100644 --- a/www/apps/docs/content/references/product/enums/ProductStatus.mdx +++ b/www/apps/docs/content/references/product/enums/ProductStatus.mdx @@ -8,24 +8,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### DRAFT +#### DRAFT **DRAFT** = `"draft"` ___ -### PROPOSED +#### PROPOSED **PROPOSED** = `"proposed"` ___ -### PUBLISHED +#### PUBLISHED **PUBLISHED** = `"published"` ___ -### REJECTED +#### REJECTED **REJECTED** = `"rejected"` diff --git a/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx b/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx index 9e8cf99fb4..b8aab0fe24 100644 --- a/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx +++ b/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx @@ -26,13 +26,13 @@ Valid string encodings: 'ascii'\|'utf8'\|'utf16le'\|'ucs2'(alias of 'utf16le')\| ## Constructors -### constructor +#### constructor `**new BufferConstructor**(str, encoding?)` Allocates a new buffer containing the given {str}. -#### Parameters +##### Parameters `: `T` extends `U` ? `never` : `T` + **Exclude**: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U -### Type parameters +#### Type Parameters `: `null` \| `T` extends `string` ? `string` \| `RegExp` : `T` extends `Date` ? `Date` \| `string` : `T` + **ExpandScalar**: `null` \| `T` extends `string` ? `string` \| `RegExp` : `T` extends `Date` ? `Date` \| `string` : `T` -### Type parameters +#### Type Parameters `: `Prev` extends `never` ? `never` : { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]> : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery<Partial<V>, PrevLimit[Prev]> : never : never : never } + **FilterQuery**: `Prev` extends `never` ? `never` : { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]> : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery<Partial<V>, PrevLimit[Prev]> : never : never : never } -### Type parameters +#### Type Parameters `: [OperatorMap](OperatorMap.mdx)<[FilterValue2](FilterValue2.mdx)<T>> \| [FilterValue2](FilterValue2.mdx)<T> \| [FilterValue2](FilterValue2.mdx)<T>[] \| `null` + **FilterValue**: [OperatorMap](OperatorMap.mdx)<[FilterValue2](FilterValue2.mdx)<T>> \| [FilterValue2](FilterValue2.mdx)<T> \| [FilterValue2](FilterValue2.mdx)<T>[] \| `null` -### Type parameters +#### Type Parameters `: `T` \| [ExpandScalar](ExpandScalar.mdx)<T> \| [Primary](Primary.mdx)<T> + **FilterValue2**: `T` \| [ExpandScalar](ExpandScalar.mdx)<T> \| [Primary](Primary.mdx)<T> -### Type parameters +#### Type Parameters `: [IteratorYieldResult](../interfaces/IteratorYieldResult.mdx)<T> \| [IteratorReturnResult](../interfaces/IteratorReturnResult.mdx)<TReturn> + **IteratorResult**: [IteratorYieldResult](../interfaces/IteratorYieldResult.mdx)<T> \| [IteratorReturnResult](../interfaces/IteratorReturnResult.mdx)<TReturn> -### Type parameters +#### Type Parameters `: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> + **Omit**: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> Construct a type with the properties of T except for those in type K. -### Type parameters +#### Type Parameters `: `Object` + **OperatorMap**: `Object` -### Type parameters +#### Type Parameters -### Type declaration +#### Type declaration `: { [P in keyof T]?: T[P] } + **Partial**: { [P in keyof T]?: T[P] } Make all properties in T optional -### Type parameters +#### Type Parameters `: { [P in K]: T[P] } + **Pick**: { [P in K]: T[P] } From T, pick a set of properties whose keys are in the union K -### Type parameters +#### Type Parameters `: `T` extends ``{ [PrimaryKeyType]?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `T` extends ``{ _id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> \| `string` : `T` extends ``{ uuid?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `T` extends ``{ id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `never` + **Primary**: `T` extends ``{ [PrimaryKeyType]?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `T` extends ``{ _id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> \| `string` : `T` extends ``{ uuid?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `T` extends ``{ id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `never` -### Type parameters +#### Type Parameters `: `T` extends `object` ? `T` extends [Scalar](Scalar.mdx) ? `never` : [FilterQuery](FilterQuery.mdx)<T> : [FilterValue](FilterValue.mdx)<T> + **Query**: `T` extends `object` ? `T` extends [Scalar](Scalar.mdx) ? `never` : [FilterQuery](FilterQuery.mdx)<T> : [FilterValue](FilterValue.mdx)<T> -### Type parameters +#### Type Parameters `: { readonly [P in keyof T]: T[P] } + **Readonly**: { readonly [P in keyof T]: T[P] } Make all properties in T readonly -### Type parameters +#### Type Parameters `: `T` extends `any`[] ? [Readonly](Readonly.mdx)<T> : `T` + **ReadonlyPrimary**: `T` extends `any`[] ? [Readonly](Readonly.mdx)<T> : `T` -### Type parameters +#### Type Parameters `: { [P in K]: T } + **Record**: { [P in K]: T } Construct a type with a set of properties K of type T -### Type parameters +#### Type Parameters `: `T` \| ``{ valueOf: Method valueOf }`` + **WithImplicitCoercion**: `T` \| ``{ valueOf: Method valueOf }`` -### Type parameters +#### Type Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -157,6 +141,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -228,13 +214,13 @@ Promise<TResult> ___ -### buildTemplate +#### buildTemplate `Abstract **buildTemplate**(): Promise<string>` Builds and returns a template file that can be downloaded and filled in -#### Returns +##### Returns Promise<string> @@ -252,10 +238,12 @@ Promise<string> ___ -### handleProcessingError +#### handleProcessingError `Protected **handleProcessingError**(batchJobId, err, result): Promise<void>` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -318,13 +306,13 @@ Promise<void> ___ -### preProcessBatchJob +#### preProcessBatchJob `**preProcessBatchJob**(batchJobId): Promise<void>` Method for pre-processing a batch job -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -356,13 +344,13 @@ Promise<void> ___ -### prepareBatchJobForProcessing +#### prepareBatchJobForProcessing `**prepareBatchJobForProcessing**(batchJob, req): Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)>` Method for preparing a batch job for processing -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)> @@ -403,13 +391,13 @@ Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)> ___ -### processJob +#### processJob `Abstract **processJob**(batchJobId): Promise<void>` Method does the actual processing of the job. Should report back on the progress of the operation. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -441,11 +429,11 @@ Promise<void> ___ -### shouldRetryOnProcessingError +#### shouldRetryOnProcessingError `Protected **shouldRetryOnProcessingError**(batchJob, err): Promise<boolean>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -486,11 +474,11 @@ Promise<boolean> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -522,11 +510,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx) diff --git a/www/apps/docs/content/references/services/classes/AbstractEventBusModuleService.mdx b/www/apps/docs/content/references/services/classes/AbstractEventBusModuleService.mdx index fea4157998..16d7a897f3 100644 --- a/www/apps/docs/content/references/services/classes/AbstractEventBusModuleService.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractEventBusModuleService.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new AbstractEventBusModuleService**()` @@ -32,32 +32,18 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Accessors -### eventToSubscribersMap +#### eventToSubscribersMap -`get**eventToSubscribersMap**(): Map<string \| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]>` - -#### Returns - -Map<string \| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]> - - + **eventToSubscribersMap**: [object Object] ## Methods -### emit +#### emit `Abstract **emit**(eventName, data, options): Promise<void>` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -120,6 +106,8 @@ Promise<void> `Abstract **emit**(data): Promise<void>` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -164,11 +152,11 @@ Promise<void> ___ -### storeSubscribers +#### storeSubscribers `Protected **storeSubscribers**(«destructured»): void` -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -227,11 +215,11 @@ ___ ___ -### subscribe +#### subscribe `**subscribe**(eventName, subscriber, context?): [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx) @@ -281,11 +269,11 @@ ___ ___ -### unsubscribe +#### unsubscribe `**unsubscribe**(eventName, subscriber, context): [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx) diff --git a/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx b/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx index df2237129a..5661309831 100644 --- a/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx @@ -12,11 +12,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `Protected **new AbstractNotificationService**(__container__, __configModule__?, __moduleDeclaration__?)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -139,6 +123,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -210,11 +196,11 @@ Promise<TResult> ___ -### getIdentifier +#### getIdentifier `**getIdentifier**(): string` -#### Returns +##### Returns `string` @@ -232,11 +218,11 @@ ___ ___ -### resendNotification +#### resendNotification `Abstract **resendNotification**(notification, config, attachmentGenerator): Promise<[ReturnedData](../types/ReturnedData.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnedData](../types/ReturnedData.mdx)> @@ -286,11 +272,11 @@ Promise<[ReturnedData](../types/ReturnedData.mdx)> ___ -### sendNotification +#### sendNotification `Abstract **sendNotification**(event, data, attachmentGenerator): Promise<[ReturnedData](../types/ReturnedData.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnedData](../types/ReturnedData.mdx)> @@ -340,11 +326,11 @@ Promise<[ReturnedData](../types/ReturnedData.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -376,11 +362,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [AbstractNotificationService](AbstractNotificationService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AbstractNotificationService](AbstractNotificationService.mdx) diff --git a/www/apps/docs/content/references/services/classes/AbstractPaymentProcessor.mdx b/www/apps/docs/content/references/services/classes/AbstractPaymentProcessor.mdx index e464859c1a..e907e13621 100644 --- a/www/apps/docs/content/references/services/classes/AbstractPaymentProcessor.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractPaymentProcessor.mdx @@ -14,11 +14,11 @@ Payment processor in charge of creating , managing and processing a payment ## Constructors -### constructor +#### constructor `Protected **new AbstractPaymentProcessor**(container, config?)` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentProcessorError](../interfaces/PaymentProcessorError.mdx) \| { data: Record<string, unknown> ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) }> @@ -122,13 +122,13 @@ Promise<[PaymentProcessorError](../interfaces/PaymentProcessorError.mdx) \| ___ -### cancelPayment +#### cancelPayment `Abstract **cancelPayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)>` Cancel an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)> @@ -160,13 +160,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](../interf ___ -### capturePayment +#### capturePayment `Abstract **capturePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)>` Capture an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)> @@ -198,13 +198,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](../interf ___ -### deletePayment +#### deletePayment `Abstract **deletePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)>` Delete an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)> @@ -236,13 +236,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](../interf ___ -### getIdentifier +#### getIdentifier `**getIdentifier**(): string` Return a unique identifier to retrieve the payment plugin provider -#### Returns +##### Returns `string` @@ -260,13 +260,13 @@ Return a unique identifier to retrieve the payment plugin provider ___ -### getPaymentStatus +#### getPaymentStatus `Abstract **getPaymentStatus**(paymentSessionData): Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>` Return the status of the session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)> @@ -298,13 +298,13 @@ Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)> ___ -### initiatePayment +#### initiatePayment `Abstract **initiatePayment**(context): Promise<[PaymentProcessorError](../interfaces/PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)>` Initiate a payment session with the external provider -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentProcessorError](../interfaces/PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)> @@ -336,13 +336,13 @@ Promise<[PaymentProcessorError](../interfaces/PaymentProcessorError.mdx) \| ___ -### refundPayment +#### refundPayment `Abstract **refundPayment**(paymentSessionData, refundAmount): Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)>` Refund an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)> @@ -383,13 +383,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](../interf ___ -### retrievePayment +#### retrievePayment `Abstract **retrievePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)>` Retrieve an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)> @@ -421,13 +421,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](../interf ___ -### updatePayment +#### updatePayment `Abstract **updatePayment**(context): Promise<void \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)>` Update an existing payment session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)> @@ -459,13 +459,13 @@ Promise<void \| [PaymentProcessorError](../interfaces/PaymentProcessorError. ___ -### updatePaymentData +#### updatePaymentData `Abstract **updatePaymentData**(sessionId, data): Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)>` Update the session data for a payment session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](../interfaces/PaymentProcessorError.mdx)> diff --git a/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx b/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx index f533650379..d6a5987ddc 100644 --- a/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx @@ -18,11 +18,11 @@ in the near future use the AbstractPaymentProcessor instead ## Constructors -### constructor +#### constructor `Protected **new AbstractPaymentService**(container, config?)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -136,6 +120,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -207,11 +193,11 @@ Promise<TResult> ___ -### authorizePayment +#### authorizePayment `Abstract **authorizePayment**(paymentSession, context): Promise<{ data: [Data](../types/Data.mdx) ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) }>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ data: [Data](../types/Data.mdx) ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) }> @@ -254,13 +240,13 @@ Promise<{ data: [Data](../types/Data.mdx) ; status: [PaymentSessionStat ___ -### cancelPayment +#### cancelPayment `Abstract **cancelPayment**(payment): Promise<[Data](../types/Data.mdx)>` This will be -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -296,13 +282,13 @@ in the near future ___ -### capturePayment +#### capturePayment `Abstract **capturePayment**(payment): Promise<[Data](../types/Data.mdx)>` This will be -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -338,11 +324,11 @@ in the near future ___ -### createPayment +#### createPayment `Abstract **createPayment**(context): Promise<[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)> @@ -376,7 +362,7 @@ Promise<[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)> This will be -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -412,13 +398,13 @@ in the near future use `createPayment(context: Cart & PaymentContext): Promise

-#### Returns +##### Returns Promise<void> @@ -454,11 +440,11 @@ in the near future ___ -### getIdentifier +#### getIdentifier `**getIdentifier**(): string` -#### Returns +##### Returns `string` @@ -476,11 +462,11 @@ ___ ___ -### getPaymentData +#### getPaymentData `Abstract **getPaymentData**(paymentSession): Promise<[Data](../types/Data.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -514,13 +500,13 @@ Promise<[Data](../types/Data.mdx)> ___ -### getStatus +#### getStatus `Abstract **getStatus**(data): Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>` This will be -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)> @@ -556,13 +542,13 @@ in the near future ___ -### refundPayment +#### refundPayment `Abstract **refundPayment**(payment, refundAmount): Promise<[Data](../types/Data.mdx)>` This will be -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -607,11 +593,11 @@ in the near future ___ -### retrievePayment +#### retrievePayment `Abstract **retrievePayment**(paymentData): Promise<[Data](../types/Data.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -645,13 +631,13 @@ Promise<[Data](../types/Data.mdx)> ___ -### retrieveSavedMethods +#### retrieveSavedMethods `**retrieveSavedMethods**(customer): Promise<[Data](../types/Data.mdx)[]>` This will be -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)[]> @@ -687,11 +673,11 @@ in the near future ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -723,11 +709,11 @@ ___ ___ -### updatePayment +#### updatePayment `Abstract **updatePayment**(paymentSessionData, context): Promise<Record<string, unknown> \| [PaymentSessionResponse](../types/PaymentSessionResponse.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentSessionResponse](../types/PaymentSessionResponse.mdx)> @@ -770,7 +756,7 @@ Promise<Record<string, unknown> \| [PaymentSessionResponse](../types This will be -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -815,11 +801,11 @@ in the near future use `updatePayment(paymentSessionData: PaymentSessionData, co ___ -### updatePaymentData +#### updatePaymentData `Abstract **updatePaymentData**(paymentSessionData, data): Promise<[Data](../types/Data.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Data](../types/Data.mdx)> @@ -862,11 +848,11 @@ Promise<[Data](../types/Data.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [AbstractPaymentService](AbstractPaymentService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AbstractPaymentService](AbstractPaymentService.mdx) diff --git a/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx b/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx index 0c0d2d8ad3..ea9aa67f70 100644 --- a/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx @@ -12,11 +12,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `Protected **new AbstractSearchService**(container, options)` -#### Parameters +##### Parameters ` - -`", - "optional": false, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } -]} /> + **options**: [object Object] ## Methods -### addDocuments +#### addDocuments `Abstract **addDocuments**(indexName, documents, type): unknown` Used to index documents by the search engine provider -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -142,13 +126,13 @@ Used to index documents by the search engine provider ___ -### createIndex +#### createIndex `Abstract **createIndex**(indexName, options): unknown` Used to create an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -189,13 +173,13 @@ Used to create an index ___ -### deleteAllDocuments +#### deleteAllDocuments `Abstract **deleteAllDocuments**(indexName): unknown` Used to delete all documents -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -227,13 +211,13 @@ Used to delete all documents ___ -### deleteDocument +#### deleteDocument `Abstract **deleteDocument**(indexName, document_id): unknown` Used to delete document -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -274,13 +258,13 @@ Used to delete document ___ -### getIndex +#### getIndex `Abstract **getIndex**(indexName): unknown` Used to get an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -312,13 +296,13 @@ Used to get an index ___ -### replaceDocuments +#### replaceDocuments `Abstract **replaceDocuments**(indexName, documents, type): unknown` Used to replace documents -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -368,13 +352,13 @@ Used to replace documents ___ -### search +#### search `Abstract **search**(indexName, query, options): unknown` Used to search for a document in an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -424,13 +408,13 @@ Used to search for a document in an index ___ -### updateSettings +#### updateSettings `Abstract **updateSettings**(indexName, settings): unknown` Used to update the settings of an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` diff --git a/www/apps/docs/content/references/services/classes/Address.mdx b/www/apps/docs/content/references/services/classes/Address.mdx index 8b7e8b7d03..0e3cf9442c 100644 --- a/www/apps/docs/content/references/services/classes/Address.mdx +++ b/www/apps/docs/content/references/services/classes/Address.mdx @@ -10,7 +10,7 @@ An address is used across the Medusa backend within other schemas and object typ ## Constructors -### constructor +#### constructor `**new Address**()` @@ -185,11 +185,11 @@ An address is used across the Medusa backend within other schemas and object typ ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/AddressCreatePayload.mdx b/www/apps/docs/content/references/services/classes/AddressCreatePayload.mdx index 5861cad871..3b34ae7a58 100644 --- a/www/apps/docs/content/references/services/classes/AddressCreatePayload.mdx +++ b/www/apps/docs/content/references/services/classes/AddressCreatePayload.mdx @@ -10,7 +10,7 @@ Address fields used when creating an address. ## Constructors -### constructor +#### constructor `**new AddressCreatePayload**()` diff --git a/www/apps/docs/content/references/services/classes/AddressPayload.mdx b/www/apps/docs/content/references/services/classes/AddressPayload.mdx index 15c876b454..69f97d5cf2 100644 --- a/www/apps/docs/content/references/services/classes/AddressPayload.mdx +++ b/www/apps/docs/content/references/services/classes/AddressPayload.mdx @@ -10,7 +10,7 @@ Address fields used when creating/updating an address. ## Constructors -### constructor +#### constructor `**new AddressPayload**()` diff --git a/www/apps/docs/content/references/services/classes/AdminGetDiscountsDiscountRuleParams.mdx b/www/apps/docs/content/references/services/classes/AdminGetDiscountsDiscountRuleParams.mdx index 29aee43338..5983808335 100644 --- a/www/apps/docs/content/references/services/classes/AdminGetDiscountsDiscountRuleParams.mdx +++ b/www/apps/docs/content/references/services/classes/AdminGetDiscountsDiscountRuleParams.mdx @@ -10,7 +10,7 @@ Filters to apply on discounts' rules. ## Constructors -### constructor +#### constructor `**new AdminGetDiscountsDiscountRuleParams**()` diff --git a/www/apps/docs/content/references/services/classes/AdminPriceListPricesCreateReq.mdx b/www/apps/docs/content/references/services/classes/AdminPriceListPricesCreateReq.mdx index 5a971296aa..c536a82569 100644 --- a/www/apps/docs/content/references/services/classes/AdminPriceListPricesCreateReq.mdx +++ b/www/apps/docs/content/references/services/classes/AdminPriceListPricesCreateReq.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new AdminPriceListPricesCreateReq**()` diff --git a/www/apps/docs/content/references/services/classes/AdminPriceListPricesUpdateReq.mdx b/www/apps/docs/content/references/services/classes/AdminPriceListPricesUpdateReq.mdx index 6de29be167..400a3c12c0 100644 --- a/www/apps/docs/content/references/services/classes/AdminPriceListPricesUpdateReq.mdx +++ b/www/apps/docs/content/references/services/classes/AdminPriceListPricesUpdateReq.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new AdminPriceListPricesUpdateReq**()` diff --git a/www/apps/docs/content/references/services/classes/AnalyticsConfig.mdx b/www/apps/docs/content/references/services/classes/AnalyticsConfig.mdx index aa93290031..7400884b1d 100644 --- a/www/apps/docs/content/references/services/classes/AnalyticsConfig.mdx +++ b/www/apps/docs/content/references/services/classes/AnalyticsConfig.mdx @@ -10,7 +10,7 @@ Base abstract entity for all entities ## Constructors -### constructor +#### constructor `**new AnalyticsConfig**()` @@ -84,11 +84,11 @@ Base abstract entity for all entities ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/AnalyticsConfigService.mdx b/www/apps/docs/content/references/services/classes/AnalyticsConfigService.mdx index 117e3bedf3..f8914ee24d 100644 --- a/www/apps/docs/content/references/services/classes/AnalyticsConfigService.mdx +++ b/www/apps/docs/content/references/services/classes/AnalyticsConfigService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new AnalyticsConfigService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -126,6 +110,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -197,13 +183,13 @@ Promise<TResult> ___ -### create +#### create `**create**(userId, data): Promise<[AnalyticsConfig](AnalyticsConfig.mdx)>` Creates an analytics config. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[AnalyticsConfig](AnalyticsConfig.mdx)> @@ -244,13 +230,13 @@ Promise<[AnalyticsConfig](AnalyticsConfig.mdx)> ___ -### delete +#### delete `**delete**(userId): Promise<void>` Deletes an analytics config. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -282,11 +268,11 @@ Promise<void> ___ -### retrieve +#### retrieve `**retrieve**(userId): Promise<[AnalyticsConfig](AnalyticsConfig.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[AnalyticsConfig](AnalyticsConfig.mdx)> @@ -318,11 +304,11 @@ Promise<[AnalyticsConfig](AnalyticsConfig.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -354,13 +340,13 @@ ___ ___ -### update +#### update `**update**(userId, update): Promise<[AnalyticsConfig](AnalyticsConfig.mdx)>` Updates an analytics config. If the config does not exist, it will be created instead. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[AnalyticsConfig](AnalyticsConfig.mdx)> @@ -401,11 +387,11 @@ Promise<[AnalyticsConfig](AnalyticsConfig.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [AnalyticsConfigService](AnalyticsConfigService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AnalyticsConfigService](AnalyticsConfigService.mdx) diff --git a/www/apps/docs/content/references/services/classes/AuthService.mdx b/www/apps/docs/content/references/services/classes/AuthService.mdx index 163d75f16d..2a558f7355 100644 --- a/www/apps/docs/content/references/services/classes/AuthService.mdx +++ b/www/apps/docs/content/references/services/classes/AuthService.mdx @@ -10,11 +10,11 @@ Can authenticate a user based on email password combination ## Constructors -### constructor +#### constructor `**new AuthService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -128,6 +112,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -199,14 +185,14 @@ Promise<TResult> ___ -### authenticate +#### authenticate `**authenticate**(email, password): Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)>` Authenticates a given user based on an email, password combination. Uses scrypt to match password with hashed value. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)> @@ -247,13 +233,13 @@ Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)> ___ -### authenticateAPIToken +#### authenticateAPIToken `**authenticateAPIToken**(token): Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)>` Authenticates a given user with an API token -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)> @@ -285,14 +271,14 @@ Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)> ___ -### authenticateCustomer +#### authenticateCustomer `**authenticateCustomer**(email, password): Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)>` Authenticates a customer based on an email, password combination. Uses scrypt to match password with hashed value. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)> @@ -333,13 +319,13 @@ Promise<[AuthenticateResult](../types/AuthenticateResult.mdx)> ___ -### comparePassword\_ +#### comparePassword\_ `Protected **comparePassword_**(password, hash): Promise<boolean>` Verifies if a password is valid given the provided password hash -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -380,11 +366,11 @@ Promise<boolean> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -416,11 +402,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [AuthService](AuthService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AuthService](AuthService.mdx) diff --git a/www/apps/docs/content/references/services/classes/BaseEntity.mdx b/www/apps/docs/content/references/services/classes/BaseEntity.mdx index 69904f512c..03721a9888 100644 --- a/www/apps/docs/content/references/services/classes/BaseEntity.mdx +++ b/www/apps/docs/content/references/services/classes/BaseEntity.mdx @@ -10,7 +10,7 @@ Base abstract entity for all entities ## Constructors -### constructor +#### constructor `**new BaseEntity**()` diff --git a/www/apps/docs/content/references/services/classes/BatchJob.mdx b/www/apps/docs/content/references/services/classes/BatchJob.mdx index c022cb13d9..b79364d6e7 100644 --- a/www/apps/docs/content/references/services/classes/BatchJob.mdx +++ b/www/apps/docs/content/references/services/classes/BatchJob.mdx @@ -10,7 +10,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat ## Constructors -### constructor +#### constructor `**new BatchJob**()` @@ -176,11 +176,11 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` @@ -198,11 +198,11 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat ___ -### loadStatus +#### loadStatus `**loadStatus**(): void` -#### Returns +##### Returns `void` @@ -220,13 +220,13 @@ ___ ___ -### toJSON +#### toJSON `**toJSON**(): [BatchJob](BatchJob.mdx)` A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not. -#### Returns +##### Returns [BatchJob](BatchJob.mdx) diff --git a/www/apps/docs/content/references/services/classes/BatchJobService.mdx b/www/apps/docs/content/references/services/classes/BatchJobService.mdx index b5d5fafe54..e9de6173c6 100644 --- a/www/apps/docs/content/references/services/classes/BatchJobService.mdx +++ b/www/apps/docs/content/references/services/classes/BatchJobService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new BatchJobService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -225,6 +209,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -296,11 +282,11 @@ Promise<TResult> ___ -### cancel +#### cancel `**cancel**(batchJobOrId): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -332,11 +318,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### complete +#### complete `**complete**(batchJobOrId): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -368,11 +354,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### confirm +#### confirm `**confirm**(batchJobOrId): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -404,11 +390,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### create +#### create `**create**(data): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -440,11 +426,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config?): Promise<[[BatchJob](BatchJob.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[BatchJob](BatchJob.mdx)[], number]> @@ -485,11 +471,11 @@ Promise<[[BatchJob](BatchJob.mdx)[], number]> ___ -### prepareBatchJobForProcessing +#### prepareBatchJobForProcessing `**prepareBatchJobForProcessing**(data, req): Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)> @@ -530,11 +516,11 @@ Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(batchJobId, config?): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -575,11 +561,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### setFailed +#### setFailed `**setFailed**(batchJobOrId, error?): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -620,11 +606,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### setPreProcessingDone +#### setPreProcessingDone `**setPreProcessingDone**(batchJobOrId): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -656,11 +642,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### setProcessing +#### setProcessing `**setProcessing**(batchJobOrId): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -692,11 +678,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -728,11 +714,11 @@ ___ ___ -### update +#### update `**update**(batchJobOrId, data): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -773,11 +759,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### updateStatus +#### updateStatus `Protected **updateStatus**(batchJobOrId, status): Promise<[BatchJob](BatchJob.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[BatchJob](BatchJob.mdx)> @@ -818,11 +804,11 @@ Promise<[BatchJob](BatchJob.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [BatchJobService](BatchJobService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [BatchJobService](BatchJobService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Cart.mdx b/www/apps/docs/content/references/services/classes/Cart.mdx index 6301a79165..003fb82c86 100644 --- a/www/apps/docs/content/references/services/classes/Cart.mdx +++ b/www/apps/docs/content/references/services/classes/Cart.mdx @@ -10,7 +10,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a ## Constructors -### constructor +#### constructor `**new Cart**()` @@ -401,11 +401,11 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a ## Methods -### afterLoad +#### afterLoad `Private **afterLoad**(): void` -#### Returns +##### Returns `void` @@ -423,11 +423,11 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a ___ -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/CartService.mdx b/www/apps/docs/content/references/services/classes/CartService.mdx index e451fb0afc..6a8e18065b 100644 --- a/www/apps/docs/content/references/services/classes/CartService.mdx +++ b/www/apps/docs/content/references/services/classes/CartService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new CartService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addLineItem +#### addLineItem `**addLineItem**(cartId, lineItem, config?): Promise<void>` Adds a line item to the cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -448,14 +432,14 @@ Use [addOrUpdateLineItems](CartService.mdx#addorupdatelineitems) instead. ___ -### addOrUpdateLineItems +#### addOrUpdateLineItems `**addOrUpdateLineItems**(cartId, lineItems, config?): Promise<void>` Adds or update one or multiple line items to the cart. It also update all existing items in the cart to have has\_shipping to false. Finally, the adjustments will be updated. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -514,7 +498,7 @@ Promise<void> ___ -### addShippingMethod +#### addShippingMethod `**addShippingMethod**(cartOrId, optionId, data?): Promise<[Cart](Cart.mdx)>` @@ -524,7 +508,7 @@ Shipping Option is a possible way to ship an order. Shipping Methods may also have additional details in the data field such as an id for a package shop. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -574,7 +558,7 @@ Promise<[Cart](Cart.mdx)> ___ -### adjustFreeShipping\_ +#### adjustFreeShipping\_ `Protected **adjustFreeShipping_**(cart, shouldAdd): Promise<void>` @@ -583,7 +567,7 @@ shipping discount If a free shipping is present, we set shipping methods price to 0 if a free shipping was present, we set shipping methods to original amount -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -624,7 +608,7 @@ Promise<void> ___ -### applyDiscount +#### applyDiscount `**applyDiscount**(cart, discountCode): Promise<void>` @@ -633,7 +617,7 @@ If discount besides free shipping is already applied, this will be overwritten Throws if discount regions does not include the cart region -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -674,7 +658,7 @@ Promise<void> ___ -### applyDiscounts +#### applyDiscounts `**applyDiscounts**(cart, discountCodes): Promise<void>` @@ -683,7 +667,7 @@ If discount besides free shipping is already applied, this will be overwritten Throws if discount regions does not include the cart region -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -724,11 +708,11 @@ Promise<void> ___ -### applyGiftCard\_ +#### applyGiftCard\_ `Protected **applyGiftCard_**(cart, code): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -769,7 +753,7 @@ Promise<void> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -777,6 +761,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -848,7 +834,7 @@ Promise<TResult> ___ -### authorizePayment +#### authorizePayment `**authorizePayment**(cartId, context?): Promise<[Cart](Cart.mdx)>` @@ -858,7 +844,7 @@ a payment object, that we will use to update our cart payment with. Additionally, if the payment does not require more or fails, we will set the payment on the cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -899,13 +885,13 @@ Promise<[Cart](Cart.mdx)> ___ -### create +#### create `**create**(data): Promise<[Cart](Cart.mdx)>` Creates a cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -937,13 +923,13 @@ Promise<[Cart](Cart.mdx)> ___ -### createOrFetchGuestCustomerFromEmail\_ +#### createOrFetchGuestCustomerFromEmail\_ `Protected **createOrFetchGuestCustomerFromEmail_**(email): Promise<[Customer](Customer.mdx)>` Creates or fetches a user based on an email. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -975,11 +961,11 @@ Promise<[Customer](Customer.mdx)> ___ -### createTaxLines +#### createTaxLines `**createTaxLines**(cartOrId): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1011,11 +997,11 @@ Promise<void> ___ -### decorateTotals +#### decorateTotals `**decorateTotals**(cart, totalsConfig?): Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), "total">>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), "total">> @@ -1056,11 +1042,11 @@ Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart] ___ -### decorateTotals\_ +#### decorateTotals\_ `Protected **decorateTotals_**(cart, totalsToSelect, options?): Promise<[Cart](Cart.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -1114,13 +1100,13 @@ Use decorateTotals instead ___ -### delete +#### delete `**delete**(cartId): Promise<[Cart](Cart.mdx)>` Deletes a cart from the database. Completed carts cannot be deleted. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -1152,13 +1138,13 @@ Promise<[Cart](Cart.mdx)> ___ -### deletePaymentSession +#### deletePaymentSession `**deletePaymentSession**(cartId, providerId): Promise<void>` Removes a payment session from the cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1199,11 +1185,11 @@ Promise<void> ___ -### deleteTaxLines +#### deleteTaxLines `**deleteTaxLines**(id): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1235,14 +1221,14 @@ Promise<void> ___ -### findCustomShippingOption +#### findCustomShippingOption `**findCustomShippingOption**(cartCustomShippingOptions, optionId): undefined \| [CustomShippingOption](CustomShippingOption.mdx)` Finds the cart's custom shipping options based on the passed option id. throws if custom options is not empty and no shipping option corresponds to optionId -#### Parameters +##### Parameters -#### Returns +##### Returns `undefined` \| [CustomShippingOption](CustomShippingOption.mdx) @@ -1283,11 +1269,11 @@ throws if custom options is not empty and no shipping option corresponds to opti ___ -### getTotalsRelations +#### getTotalsRelations `Private **getTotalsRelations**(config): string[]` -#### Parameters +##### Parameters -#### Returns +##### Returns `string`[] @@ -1319,11 +1305,11 @@ ___ ___ -### getValidatedSalesChannel +#### getValidatedSalesChannel `Protected **getValidatedSalesChannel**(salesChannelId?): Promise<[SalesChannel](SalesChannel.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -1355,11 +1341,11 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### list +#### list `**list**(selector, config?): Promise<[Cart](Cart.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)[]> @@ -1400,13 +1386,13 @@ Promise<[Cart](Cart.mdx)[]> ___ -### onSalesChannelChange +#### onSalesChannelChange `Protected **onSalesChannelChange**(cart, newSalesChannelId): Promise<void>` Remove the cart line item that does not belongs to the newly assigned sales channel -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1447,11 +1433,11 @@ Promise<void> ___ -### refreshAdjustments\_ +#### refreshAdjustments\_ `Protected **refreshAdjustments_**(cart): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1483,13 +1469,13 @@ Promise<void> ___ -### refreshPaymentSession +#### refreshPaymentSession `**refreshPaymentSession**(cartId, providerId): Promise<void>` Refreshes a payment session on a cart -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1530,13 +1516,13 @@ Promise<void> ___ -### removeDiscount +#### removeDiscount `**removeDiscount**(cartId, discountCode): Promise<[Cart](Cart.mdx)>` Removes a discount based on a discount code. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -1577,13 +1563,13 @@ Promise<[Cart](Cart.mdx)> ___ -### removeLineItem +#### removeLineItem `**removeLineItem**(cartId, lineItemId): Promise<[Cart](Cart.mdx)>` Removes a line item from the cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -1624,13 +1610,13 @@ Promise<[Cart](Cart.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(cartId, options?, totalsConfig?): Promise<[Cart](Cart.mdx)>` Gets a cart by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -1680,11 +1666,11 @@ Promise<[Cart](Cart.mdx)> ___ -### retrieveLegacy +#### retrieveLegacy `Protected **retrieveLegacy**(cartId, options?, totalsConfig?): Promise<[Cart](Cart.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -1736,11 +1722,11 @@ Promise<[Cart](Cart.mdx)> ___ -### retrieveWithTotals +#### retrieveWithTotals `**retrieveWithTotals**(cartId, options?, totalsConfig?): Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), "total">>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), "total">> @@ -1790,7 +1776,7 @@ Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart] ___ -### setMetadata +#### setMetadata `**setMetadata**(cartId, key, value): Promise<[Cart](Cart.mdx)>` @@ -1798,7 +1784,7 @@ Dedicated method to set metadata for a cart. To ensure that plugins does not overwrite each others metadata fields, setMetadata is provided. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -1848,13 +1834,13 @@ Promise<[Cart](Cart.mdx)> ___ -### setPaymentSession +#### setPaymentSession `**setPaymentSession**(cartId, providerId): Promise<void>` Selects a payment session for a cart and creates a payment object in the external provider system -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1895,7 +1881,7 @@ Promise<void> ___ -### setPaymentSessions +#### setPaymentSessions `**setPaymentSessions**(cartOrCartId): Promise<void>` @@ -1905,7 +1891,7 @@ provider. Additional calls will ensure that payment sessions have correct amounts, currencies, etc. as well as make sure to filter payment sessions that are not available for the cart's region. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1937,13 +1923,13 @@ Promise<void> ___ -### setRegion\_ +#### setRegion\_ `Protected **setRegion_**(cart, regionId, countryCode): Promise<void>` Set's the region of a cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1993,11 +1979,11 @@ Promise<void> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -2029,11 +2015,11 @@ ___ ___ -### transformQueryForTotals\_ +#### transformQueryForTotals\_ `Protected **transformQueryForTotals_**(config): [FindConfig](../interfaces/FindConfig.mdx)<[Cart](Cart.mdx)> & { totalsToSelect: [TotalField](../types/TotalField.mdx)[] }` -#### Parameters +##### Parameters -#### Returns +##### Returns [FindConfig](../interfaces/FindConfig.mdx)<[Cart](Cart.mdx)> & ``{ totalsToSelect: [TotalField](../types/TotalField.mdx)[] }`` @@ -2065,11 +2051,11 @@ ___ ___ -### update +#### update `**update**(cartOrId, data): Promise<[Cart](Cart.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -2110,13 +2096,13 @@ Promise<[Cart](Cart.mdx)> ___ -### updateBillingAddress\_ +#### updateBillingAddress\_ `Protected **updateBillingAddress_**(cart, addressOrId, addrRepo): Promise<void>` Updates the cart's billing address. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -2166,13 +2152,13 @@ Promise<void> ___ -### updateCustomerId\_ +#### updateCustomerId\_ `Protected **updateCustomerId_**(cart, customerId): Promise<void>` Sets the customer id of a cart -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -2213,13 +2199,13 @@ Promise<void> ___ -### updateLineItem +#### updateLineItem `**updateLineItem**(cartId, lineItemId, update): Promise<[Cart](Cart.mdx)>` Updates a cart's existing line item. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -2269,13 +2255,13 @@ Promise<[Cart](Cart.mdx)> ___ -### updatePaymentSession +#### updatePaymentSession `**updatePaymentSession**(cartId, update): Promise<[Cart](Cart.mdx)>` Updates the currently selected payment session. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Cart](Cart.mdx)> @@ -2316,13 +2302,13 @@ Promise<[Cart](Cart.mdx)> ___ -### updateShippingAddress\_ +#### updateShippingAddress\_ `Protected **updateShippingAddress_**(cart, addressOrId, addrRepo): Promise<void>` Updates the cart's shipping address. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -2372,11 +2358,11 @@ Promise<void> ___ -### updateUnitPrices\_ +#### updateUnitPrices\_ `Protected **updateUnitPrices_**(cart, regionId?, customer_id?): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -2426,13 +2412,13 @@ Promise<void> ___ -### validateLineItem +#### validateLineItem `Protected **validateLineItem**(sales_channel_id, lineItem): Promise<boolean>` Check if line item's variant belongs to the cart's sales channel. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -2482,7 +2468,7 @@ Promise<boolean> ___ -### validateLineItemShipping\_ +#### validateLineItemShipping\_ `Protected **validateLineItemShipping_**(shippingMethods, lineItemShippingProfiledId): boolean` @@ -2490,7 +2476,7 @@ Checks if a given line item has a shipping method that can fulfill it. Returns true if all products in the cart can be fulfilled with the current shipping methods. -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -2531,11 +2517,11 @@ shipping methods. ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [CartService](CartService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [CartService](CartService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ClaimImage.mdx b/www/apps/docs/content/references/services/classes/ClaimImage.mdx index 5250d6c51c..70fd2763f7 100644 --- a/www/apps/docs/content/references/services/classes/ClaimImage.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimImage.mdx @@ -10,7 +10,7 @@ The details of an image attached to a claim. ## Constructors -### constructor +#### constructor `**new ClaimImage**()` @@ -95,11 +95,11 @@ The details of an image attached to a claim. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ClaimItem.mdx b/www/apps/docs/content/references/services/classes/ClaimItem.mdx index cf9a41dde9..fa71c94f93 100644 --- a/www/apps/docs/content/references/services/classes/ClaimItem.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimItem.mdx @@ -10,7 +10,7 @@ A claim item is an item created as part of a claim. It references an item in the ## Constructors -### constructor +#### constructor `**new ClaimItem**()` @@ -167,11 +167,11 @@ A claim item is an item created as part of a claim. It references an item in the ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ClaimItemService.mdx b/www/apps/docs/content/references/services/classes/ClaimItemService.mdx index 8c8fc014f0..7eb037b465 100644 --- a/www/apps/docs/content/references/services/classes/ClaimItemService.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimItemService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ClaimItemService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -189,6 +173,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -260,11 +246,11 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[ClaimItem](ClaimItem.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimItem](ClaimItem.mdx)> @@ -296,11 +282,11 @@ Promise<[ClaimItem](ClaimItem.mdx)> ___ -### list +#### list `**list**(selector, config?): Promise<[ClaimItem](ClaimItem.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimItem](ClaimItem.mdx)[]> @@ -341,13 +327,13 @@ Promise<[ClaimItem](ClaimItem.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(claimItemId, config?): Promise<[ClaimItem](ClaimItem.mdx)>` Gets a claim item by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimItem](ClaimItem.mdx)> @@ -388,11 +374,11 @@ Promise<[ClaimItem](ClaimItem.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -424,11 +410,11 @@ ___ ___ -### update +#### update `**update**(id, data): Promise<[ClaimItem](ClaimItem.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimItem](ClaimItem.mdx)> @@ -469,11 +455,11 @@ Promise<[ClaimItem](ClaimItem.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ClaimItemService](ClaimItemService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ClaimItemService](ClaimItemService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ClaimOrder.mdx b/www/apps/docs/content/references/services/classes/ClaimOrder.mdx index 626ba5dfef..88dc988005 100644 --- a/www/apps/docs/content/references/services/classes/ClaimOrder.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimOrder.mdx @@ -10,7 +10,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item ## Constructors -### constructor +#### constructor `**new ClaimOrder**()` @@ -212,11 +212,11 @@ A Claim represents a group of faulty or missing items. It consists of claim item ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ClaimService.mdx b/www/apps/docs/content/references/services/classes/ClaimService.mdx index 7d840fc458..f58f205137 100644 --- a/www/apps/docs/content/references/services/classes/ClaimService.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ClaimService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -315,6 +299,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -386,11 +372,11 @@ Promise<TResult> ___ -### cancel +#### cancel `**cancel**(id): Promise<[ClaimOrder](ClaimOrder.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -422,11 +408,11 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### cancelFulfillment +#### cancelFulfillment `**cancelFulfillment**(fulfillmentId): Promise<[ClaimOrder](ClaimOrder.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -458,7 +444,7 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### create +#### create `**create**(data): Promise<[ClaimOrder](ClaimOrder.mdx)>` @@ -466,7 +452,7 @@ Creates a Claim on an Order. Claims consists of items that are claimed and optionally items to be sent as replacement for the claimed items. The shipping address that the new items will be shipped to -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -498,11 +484,11 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### createFulfillment +#### createFulfillment `**createFulfillment**(id, config?): Promise<[ClaimOrder](ClaimOrder.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -570,11 +556,11 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### createShipment +#### createShipment `**createShipment**(id, fulfillmentId, trackingLinks?, config?): Promise<[ClaimOrder](ClaimOrder.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -651,7 +637,7 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### getRefundTotalForClaimLinesOnOrder +#### getRefundTotalForClaimLinesOnOrder `Protected **getRefundTotalForClaimLinesOnOrder**(order, claimItems): Promise<number>` @@ -662,7 +648,7 @@ There are three places too look: - Claim items (from previous claims) Note, it will attempt to return early from each of these places to avoid having to iterate over all items every time. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -703,11 +689,11 @@ Promise<number> ___ -### list +#### list `**list**(selector, config?): Promise<[ClaimOrder](ClaimOrder.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)[]> @@ -748,11 +734,11 @@ Promise<[ClaimOrder](ClaimOrder.mdx)[]> ___ -### processRefund +#### processRefund `**processRefund**(id): Promise<[ClaimOrder](ClaimOrder.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -784,13 +770,13 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(claimId, config?): Promise<[ClaimOrder](ClaimOrder.mdx)>` Gets an order by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -831,11 +817,11 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -867,11 +853,11 @@ ___ ___ -### update +#### update `**update**(id, data): Promise<[ClaimOrder](ClaimOrder.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ClaimOrder](ClaimOrder.mdx)> @@ -912,11 +898,11 @@ Promise<[ClaimOrder](ClaimOrder.mdx)> ___ -### validateCreateClaimInput +#### validateCreateClaimInput `Protected **validateCreateClaimInput**(data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -948,11 +934,11 @@ Promise<void> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ClaimService](ClaimService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ClaimService](ClaimService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ClaimTag.mdx b/www/apps/docs/content/references/services/classes/ClaimTag.mdx index ebb3a3d651..13aa2ce592 100644 --- a/www/apps/docs/content/references/services/classes/ClaimTag.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimTag.mdx @@ -10,7 +10,7 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi ## Constructors -### constructor +#### constructor `**new ClaimTag**()` @@ -77,11 +77,11 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/Country.mdx b/www/apps/docs/content/references/services/classes/Country.mdx index 11d711d28e..616f640ab1 100644 --- a/www/apps/docs/content/references/services/classes/Country.mdx +++ b/www/apps/docs/content/references/services/classes/Country.mdx @@ -10,7 +10,7 @@ Country details ## Constructors -### constructor +#### constructor `**new Country**()` diff --git a/www/apps/docs/content/references/services/classes/Currency.mdx b/www/apps/docs/content/references/services/classes/Currency.mdx index 1d0e47f406..f21bd55e4f 100644 --- a/www/apps/docs/content/references/services/classes/Currency.mdx +++ b/www/apps/docs/content/references/services/classes/Currency.mdx @@ -10,7 +10,7 @@ Currency ## Constructors -### constructor +#### constructor `**new Currency**()` diff --git a/www/apps/docs/content/references/services/classes/CurrencyService.mdx b/www/apps/docs/content/references/services/classes/CurrencyService.mdx index dcfbb383f1..4d4f8879b9 100644 --- a/www/apps/docs/content/references/services/classes/CurrencyService.mdx +++ b/www/apps/docs/content/references/services/classes/CurrencyService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new CurrencyService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -153,6 +137,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -224,14 +210,14 @@ Promise<TResult> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Currency](Currency.mdx)[], number]>` Lists currencies based on the provided parameters and includes the count of currencies that match the query. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Currency](Currency.mdx)[], number]> @@ -272,13 +258,13 @@ Promise<[[Currency](Currency.mdx)[], number]> ___ -### retrieveByCode +#### retrieveByCode `**retrieveByCode**(code): Promise<[Currency](Currency.mdx)>` Return the currency -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Currency](Currency.mdx)> @@ -310,11 +296,11 @@ Promise<[Currency](Currency.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -346,13 +332,13 @@ ___ ___ -### update +#### update `**update**(code, data): Promise<undefined \| [Currency](Currency.mdx)>` Update a currency -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| [Currency](Currency.mdx)> @@ -393,11 +379,11 @@ Promise<undefined \| [Currency](Currency.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [CurrencyService](CurrencyService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [CurrencyService](CurrencyService.mdx) diff --git a/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx b/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx index 4c3003f377..a54f4bb56a 100644 --- a/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx +++ b/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx @@ -10,7 +10,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus ## Constructors -### constructor +#### constructor `**new CustomShippingOption**()` @@ -113,11 +113,11 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx b/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx index 6cda8f294c..6032289bae 100644 --- a/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx +++ b/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new CustomShippingOptionService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -117,6 +101,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -188,12 +174,14 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<TResult>` Creates a custom shipping option +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -247,13 +235,13 @@ Promise<TResult> ___ -### list +#### list `**list**(selector, config?): Promise<[CustomShippingOption](CustomShippingOption.mdx)[]>` Fetches all custom shipping options based on the given selector -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomShippingOption](CustomShippingOption.mdx)[]> @@ -294,13 +282,13 @@ Promise<[CustomShippingOption](CustomShippingOption.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(id, config?): Promise<[CustomShippingOption](CustomShippingOption.mdx)>` Retrieves a specific shipping option. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomShippingOption](CustomShippingOption.mdx)> @@ -341,11 +329,11 @@ Promise<[CustomShippingOption](CustomShippingOption.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -377,11 +365,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [CustomShippingOptionService](CustomShippingOptionService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [CustomShippingOptionService](CustomShippingOptionService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Customer.mdx b/www/apps/docs/content/references/services/classes/Customer.mdx index 9db4b0174e..cfb9ab00f0 100644 --- a/www/apps/docs/content/references/services/classes/Customer.mdx +++ b/www/apps/docs/content/references/services/classes/Customer.mdx @@ -10,7 +10,7 @@ A customer can make purchases in your store and manage their profile. ## Constructors -### constructor +#### constructor `**new Customer**()` @@ -167,11 +167,11 @@ A customer can make purchases in your store and manage their profile. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/CustomerGroup.mdx b/www/apps/docs/content/references/services/classes/CustomerGroup.mdx index f033385eae..5be717861c 100644 --- a/www/apps/docs/content/references/services/classes/CustomerGroup.mdx +++ b/www/apps/docs/content/references/services/classes/CustomerGroup.mdx @@ -10,7 +10,7 @@ A customer group that can be used to organize customers into groups of similar t ## Constructors -### constructor +#### constructor `**new CustomerGroup**()` @@ -95,11 +95,11 @@ A customer group that can be used to organize customers into groups of similar t ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx b/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx index dc756c9070..11758d0a72 100644 --- a/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx +++ b/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new CustomerGroupService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addCustomers +#### addCustomers `**addCustomers**(id, customerIds): Promise<[CustomerGroup](CustomerGroup.mdx)>` Add a batch of customers to a customer group at once -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomerGroup](CustomerGroup.mdx)> @@ -165,7 +149,7 @@ Promise<[CustomerGroup](CustomerGroup.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -173,6 +157,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -244,13 +230,13 @@ Promise<TResult> ___ -### create +#### create `**create**(group): Promise<[CustomerGroup](CustomerGroup.mdx)>` Creates a customer group with the provided data. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomerGroup](CustomerGroup.mdx)> @@ -282,13 +268,13 @@ Promise<[CustomerGroup](CustomerGroup.mdx)> ___ -### delete +#### delete `**delete**(groupId): Promise<void>` Remove customer group -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -320,11 +306,11 @@ Promise<void> ___ -### handleCreationFail +#### handleCreationFail `Private **handleCreationFail**(id, ids, error): Promise<never>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<never> @@ -374,13 +360,13 @@ Promise<never> ___ -### list +#### list `**list**(selector?, config): Promise<[CustomerGroup](CustomerGroup.mdx)[]>` List customer groups. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomerGroup](CustomerGroup.mdx)[]> @@ -421,13 +407,13 @@ Promise<[CustomerGroup](CustomerGroup.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config): Promise<[[CustomerGroup](CustomerGroup.mdx)[], number]>` Retrieve a list of customer groups and total count of records that match the query. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[CustomerGroup](CustomerGroup.mdx)[], number]> @@ -468,13 +454,13 @@ Promise<[[CustomerGroup](CustomerGroup.mdx)[], number]> ___ -### removeCustomer +#### removeCustomer `**removeCustomer**(id, customerIds): Promise<[CustomerGroup](CustomerGroup.mdx)>` Remove list of customers from a customergroup -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomerGroup](CustomerGroup.mdx)> @@ -515,11 +501,11 @@ Promise<[CustomerGroup](CustomerGroup.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(customerGroupId, config?): Promise<[CustomerGroup](CustomerGroup.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomerGroup](CustomerGroup.mdx)> @@ -560,11 +546,11 @@ Promise<[CustomerGroup](CustomerGroup.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -596,13 +582,13 @@ ___ ___ -### update +#### update `**update**(customerGroupId, update): Promise<[CustomerGroup](CustomerGroup.mdx)>` Update a customer group. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CustomerGroup](CustomerGroup.mdx)> @@ -643,11 +629,11 @@ Promise<[CustomerGroup](CustomerGroup.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [CustomerGroupService](CustomerGroupService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [CustomerGroupService](CustomerGroupService.mdx) diff --git a/www/apps/docs/content/references/services/classes/CustomerGroupUpdate.mdx b/www/apps/docs/content/references/services/classes/CustomerGroupUpdate.mdx index aefc8765fa..26cf206754 100644 --- a/www/apps/docs/content/references/services/classes/CustomerGroupUpdate.mdx +++ b/www/apps/docs/content/references/services/classes/CustomerGroupUpdate.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new CustomerGroupUpdate**()` diff --git a/www/apps/docs/content/references/services/classes/CustomerService.mdx b/www/apps/docs/content/references/services/classes/CustomerService.mdx index c66628423e..529bf73f68 100644 --- a/www/apps/docs/content/references/services/classes/CustomerService.mdx +++ b/www/apps/docs/content/references/services/classes/CustomerService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate customers. ## Constructors -### constructor +#### constructor `**new CustomerService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addAddress +#### addAddress `**addAddress**(customerId, address): Promise<[Customer](Customer.mdx) \| [Address](Address.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx) \| [Address](Address.mdx)> @@ -210,7 +194,7 @@ Promise<[Customer](Customer.mdx) \| [Address](Address.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -218,6 +202,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -289,13 +275,13 @@ Promise<TResult> ___ -### count +#### count `**count**(): Promise<number>` Return the total number of documents in database -#### Returns +##### Returns Promise<number> @@ -313,7 +299,7 @@ Promise<number> ___ -### create +#### create `**create**(customer): Promise<[Customer](Customer.mdx)>` @@ -322,7 +308,7 @@ e.g. to login and view order history, etc. If a password is provided the customer will automatically get an account, otherwise the customer is just used to hold details of customers. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -354,13 +340,13 @@ Promise<[Customer](Customer.mdx)> ___ -### delete +#### delete `**delete**(customerId): Promise<void \| [Customer](Customer.mdx)>` Deletes a customer from a given customer id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [Customer](Customer.mdx)> @@ -392,7 +378,7 @@ Promise<void \| [Customer](Customer.mdx)> ___ -### generateResetPasswordToken +#### generateResetPasswordToken `**generateResetPasswordToken**(customerId): Promise<string>` @@ -402,7 +388,7 @@ The token will be signed with the customer's current password hash as a secret a long side a payload with userId and the expiry time for the token, which is always 15 minutes. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string> @@ -434,13 +420,13 @@ Promise<string> ___ -### hashPassword\_ +#### hashPassword\_ `**hashPassword_**(password): Promise<string>` Hashes a password -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string> @@ -472,11 +458,11 @@ Promise<string> ___ -### list +#### list `**list**(selector?, config?): Promise<[Customer](Customer.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)[]> @@ -517,11 +503,11 @@ Promise<[Customer](Customer.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Customer](Customer.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Customer](Customer.mdx)[], number]> @@ -562,11 +548,11 @@ Promise<[[Customer](Customer.mdx)[], number]> ___ -### listByEmail +#### listByEmail `**listByEmail**(email, config?): Promise<[Customer](Customer.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)[]> @@ -607,11 +593,11 @@ Promise<[Customer](Customer.mdx)[]> ___ -### removeAddress +#### removeAddress `**removeAddress**(customerId, addressId): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -652,13 +638,13 @@ Promise<void> ___ -### retrieve +#### retrieve `**retrieve**(customerId, config?): Promise<[Customer](Customer.mdx)>` Gets a customer by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -699,13 +685,13 @@ Promise<[Customer](Customer.mdx)> ___ -### retrieveByEmail +#### retrieveByEmail `**retrieveByEmail**(email, config?): Promise<[Customer](Customer.mdx)>` Gets a registered customer by email. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -748,13 +734,13 @@ Promise<[Customer](Customer.mdx)> ___ -### retrieveByPhone +#### retrieveByPhone `**retrieveByPhone**(phone, config?): Promise<[Customer](Customer.mdx)>` Gets a customer by phone. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -795,11 +781,11 @@ Promise<[Customer](Customer.mdx)> ___ -### retrieveRegisteredByEmail +#### retrieveRegisteredByEmail `**retrieveRegisteredByEmail**(email, config?): Promise<[Customer](Customer.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -840,11 +826,11 @@ Promise<[Customer](Customer.mdx)> ___ -### retrieveUnregisteredByEmail +#### retrieveUnregisteredByEmail `**retrieveUnregisteredByEmail**(email, config?): Promise<[Customer](Customer.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -885,11 +871,11 @@ Promise<[Customer](Customer.mdx)> ___ -### retrieve\_ +#### retrieve\_ `Private **retrieve_**(selector, config?): Promise<[Customer](Customer.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -930,11 +916,11 @@ Promise<[Customer](Customer.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -966,13 +952,13 @@ ___ ___ -### update +#### update `**update**(customerId, update): Promise<[Customer](Customer.mdx)>` Updates a customer. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Customer](Customer.mdx)> @@ -1013,11 +999,11 @@ Promise<[Customer](Customer.mdx)> ___ -### updateAddress +#### updateAddress `**updateAddress**(customerId, addressId, address): Promise<[Address](Address.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Address](Address.mdx)> @@ -1067,13 +1053,13 @@ Promise<[Address](Address.mdx)> ___ -### updateBillingAddress\_ +#### updateBillingAddress\_ `**updateBillingAddress_**(customer, addressOrId): Promise<void>` Updates the customers' billing address. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1114,11 +1100,11 @@ Promise<void> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [CustomerService](CustomerService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [CustomerService](CustomerService.mdx) diff --git a/www/apps/docs/content/references/services/classes/DateComparisonOperator.mdx b/www/apps/docs/content/references/services/classes/DateComparisonOperator.mdx index 4450749c98..a102309ea8 100644 --- a/www/apps/docs/content/references/services/classes/DateComparisonOperator.mdx +++ b/www/apps/docs/content/references/services/classes/DateComparisonOperator.mdx @@ -10,7 +10,7 @@ Fields used to apply flexible filters on dates. ## Constructors -### constructor +#### constructor `**new DateComparisonOperator**()` diff --git a/www/apps/docs/content/references/services/classes/Discount-1.mdx b/www/apps/docs/content/references/services/classes/Discount-1.mdx index 1584a45349..33a13299f5 100644 --- a/www/apps/docs/content/references/services/classes/Discount-1.mdx +++ b/www/apps/docs/content/references/services/classes/Discount-1.mdx @@ -10,7 +10,7 @@ A discount can be applied to a cart for promotional purposes. ## Constructors -### constructor +#### constructor `**new Discount**()` diff --git a/www/apps/docs/content/references/services/classes/Discount.mdx b/www/apps/docs/content/references/services/classes/Discount.mdx index d4704c3785..3ccc281690 100644 --- a/www/apps/docs/content/references/services/classes/Discount.mdx +++ b/www/apps/docs/content/references/services/classes/Discount.mdx @@ -10,7 +10,7 @@ A discount can be applied to a cart for promotional purposes. ## Constructors -### constructor +#### constructor `**new Discount**()` @@ -185,11 +185,11 @@ A discount can be applied to a cart for promotional purposes. ## Methods -### upperCaseCodeAndTrim +#### upperCaseCodeAndTrim `Private **upperCaseCodeAndTrim**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/DiscountCondition.mdx b/www/apps/docs/content/references/services/classes/DiscountCondition.mdx index 7b80472b07..f176735bbb 100644 --- a/www/apps/docs/content/references/services/classes/DiscountCondition.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountCondition.mdx @@ -10,7 +10,7 @@ Holds rule conditions for when a discount is applicable ## Constructors -### constructor +#### constructor `**new DiscountCondition**()` @@ -149,11 +149,11 @@ Holds rule conditions for when a discount is applicable ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/DiscountConditionCustomerGroup.mdx b/www/apps/docs/content/references/services/classes/DiscountConditionCustomerGroup.mdx index 639eb3a8fd..75a579a0b0 100644 --- a/www/apps/docs/content/references/services/classes/DiscountConditionCustomerGroup.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountConditionCustomerGroup.mdx @@ -10,7 +10,7 @@ Associates a discount condition with a customer group ## Constructors -### constructor +#### constructor `**new DiscountConditionCustomerGroup**()` diff --git a/www/apps/docs/content/references/services/classes/DiscountConditionProduct.mdx b/www/apps/docs/content/references/services/classes/DiscountConditionProduct.mdx index 00694cc76b..1376a1e5ad 100644 --- a/www/apps/docs/content/references/services/classes/DiscountConditionProduct.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountConditionProduct.mdx @@ -10,7 +10,7 @@ This represents the association between a discount condition and a product ## Constructors -### constructor +#### constructor `**new DiscountConditionProduct**()` diff --git a/www/apps/docs/content/references/services/classes/DiscountConditionProductCollection.mdx b/www/apps/docs/content/references/services/classes/DiscountConditionProductCollection.mdx index f300f165d7..9cffbd74b1 100644 --- a/www/apps/docs/content/references/services/classes/DiscountConditionProductCollection.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountConditionProductCollection.mdx @@ -10,7 +10,7 @@ This represents the association between a discount condition and a product colle ## Constructors -### constructor +#### constructor `**new DiscountConditionProductCollection**()` diff --git a/www/apps/docs/content/references/services/classes/DiscountConditionProductTag.mdx b/www/apps/docs/content/references/services/classes/DiscountConditionProductTag.mdx index 07f815573a..2e4b43e46a 100644 --- a/www/apps/docs/content/references/services/classes/DiscountConditionProductTag.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountConditionProductTag.mdx @@ -10,7 +10,7 @@ This represents the association between a discount condition and a product tag ## Constructors -### constructor +#### constructor `**new DiscountConditionProductTag**()` diff --git a/www/apps/docs/content/references/services/classes/DiscountConditionProductType.mdx b/www/apps/docs/content/references/services/classes/DiscountConditionProductType.mdx index 5575cee692..deb5a22088 100644 --- a/www/apps/docs/content/references/services/classes/DiscountConditionProductType.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountConditionProductType.mdx @@ -10,7 +10,7 @@ This represents the association between a discount condition and a product type ## Constructors -### constructor +#### constructor `**new DiscountConditionProductType**()` diff --git a/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx b/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx index 3db4f464f5..1933a9f5b2 100644 --- a/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx @@ -12,11 +12,11 @@ Provides layer to manipulate discount conditions. ## Constructors -### constructor +#### constructor `**new DiscountConditionService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -130,6 +114,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -201,11 +187,11 @@ Promise<TResult> ___ -### delete +#### delete `**delete**(discountConditionId): Promise<void \| [DiscountCondition](DiscountCondition.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [DiscountCondition](DiscountCondition.mdx)> @@ -237,11 +223,11 @@ Promise<void \| [DiscountCondition](DiscountCondition.mdx)> ___ -### removeResources +#### removeResources `**removeResources**(data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -273,11 +259,11 @@ Promise<void> ___ -### retrieve +#### retrieve `**retrieve**(conditionId, config?): Promise<[DiscountCondition](DiscountCondition.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[DiscountCondition](DiscountCondition.mdx)> @@ -318,11 +304,11 @@ Promise<[DiscountCondition](DiscountCondition.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -354,11 +340,11 @@ ___ ___ -### upsertCondition +#### upsertCondition `**upsertCondition**(data, overrideExisting?): Promise<([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [DiscountConditionProductType](DiscountConditionProductType.mdx) \| [DiscountConditionProductCollection](DiscountConditionProductCollection.mdx) \| [DiscountConditionProductTag](DiscountConditionProductTag.mdx) \| [DiscountConditionCustomerGroup](DiscountConditionCustomerGroup.mdx))[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [DiscountConditionProductType](DiscountConditionProductType.mdx) \| [DiscountConditionProductCollection](DiscountConditionProductCollection.mdx) \| [DiscountConditionProductTag](DiscountConditionProductTag.mdx) \| [DiscountConditionCustomerGroup](DiscountConditionCustomerGroup.mdx))[]> @@ -399,11 +385,11 @@ Promise<([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [Discou ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [DiscountConditionService](DiscountConditionService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [DiscountConditionService](DiscountConditionService.mdx) @@ -435,11 +421,11 @@ ___ ___ -### resolveConditionType\_ +#### resolveConditionType\_ `Static Protected **resolveConditionType_**(data): undefined \| { resource_ids: (string \| { id: string })[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) }` -#### Parameters +##### Parameters -#### Returns +##### Returns `undefined` \| ``{ resource_ids: (string \| { id: string })[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) }`` diff --git a/www/apps/docs/content/references/services/classes/DiscountRule.mdx b/www/apps/docs/content/references/services/classes/DiscountRule.mdx index a60fb78dca..94de254561 100644 --- a/www/apps/docs/content/references/services/classes/DiscountRule.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountRule.mdx @@ -10,7 +10,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. ## Constructors -### constructor +#### constructor `**new DiscountRule**()` @@ -113,11 +113,11 @@ A discount rule defines how a Discount is calculated when applied to a Cart. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/DiscountService.mdx b/www/apps/docs/content/references/services/classes/DiscountService.mdx index ab7b4cfb68..58f7674384 100644 --- a/www/apps/docs/content/references/services/classes/DiscountService.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountService.mdx @@ -12,11 +12,11 @@ Provides layer to manipulate discounts. ## Constructors -### constructor +#### constructor `**new DiscountService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addRegion +#### addRegion `**addRegion**(discountId, regionId): Promise<[Discount](Discount.mdx)>` Adds a region to the discount regions array. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)> @@ -259,7 +243,7 @@ Promise<[Discount](Discount.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -267,6 +251,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -338,11 +324,11 @@ Promise<TResult> ___ -### calculateDiscountForLineItem +#### calculateDiscountForLineItem `**calculateDiscountForLineItem**(discountId, lineItem, calculationContextData): Promise<number>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -392,11 +378,11 @@ Promise<number> ___ -### canApplyForCustomer +#### canApplyForCustomer `**canApplyForCustomer**(discountRuleId, customerId): Promise<boolean>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -437,14 +423,14 @@ Promise<boolean> ___ -### create +#### create `**create**(discount): Promise<[Discount](Discount.mdx)>` Creates a discount with provided data given that the data is validated. Normalizes discount code to uppercase. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)> @@ -476,13 +462,13 @@ Promise<[Discount](Discount.mdx)> ___ -### createDynamicCode +#### createDynamicCode `**createDynamicCode**(discountId, data): Promise<[Discount](Discount.mdx)>` Creates a dynamic code for a discount id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)> @@ -523,13 +509,13 @@ Promise<[Discount](Discount.mdx)> ___ -### delete +#### delete `**delete**(discountId): Promise<void>` Deletes a discount idempotently -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -561,13 +547,13 @@ Promise<void> ___ -### deleteDynamicCode +#### deleteDynamicCode `**deleteDynamicCode**(discountId, code): Promise<void>` Deletes a dynamic code for a discount id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -608,11 +594,11 @@ Promise<void> ___ -### hasCustomersGroupCondition +#### hasCustomersGroupCondition `**hasCustomersGroupCondition**(discount): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -644,11 +630,11 @@ ___ ___ -### hasExpired +#### hasExpired `**hasExpired**(discount): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -680,11 +666,11 @@ ___ ___ -### hasNotStarted +#### hasNotStarted `**hasNotStarted**(discount): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -716,11 +702,11 @@ ___ ___ -### hasReachedLimit +#### hasReachedLimit `**hasReachedLimit**(discount): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -752,11 +738,11 @@ ___ ___ -### isDisabled +#### isDisabled `**isDisabled**(discount): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -788,11 +774,11 @@ ___ ___ -### isValidForRegion +#### isValidForRegion `**isValidForRegion**(discount, region_id): Promise<boolean>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -833,11 +819,11 @@ Promise<boolean> ___ -### list +#### list `**list**(selector?, config?): Promise<[Discount](Discount.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)[]> @@ -878,11 +864,11 @@ Promise<[Discount](Discount.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config?): Promise<[[Discount](Discount.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Discount](Discount.mdx)[], number]> @@ -923,13 +909,13 @@ Promise<[[Discount](Discount.mdx)[], number]> ___ -### listByCodes +#### listByCodes `**listByCodes**(discountCodes, config?): Promise<[Discount](Discount.mdx)[]>` List all the discounts corresponding to the given codes -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)[]> @@ -970,13 +956,13 @@ Promise<[Discount](Discount.mdx)[]> ___ -### removeRegion +#### removeRegion `**removeRegion**(discountId, regionId): Promise<[Discount](Discount.mdx)>` Removes a region from the discount regions array. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)> @@ -1017,13 +1003,13 @@ Promise<[Discount](Discount.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(discountId, config?): Promise<[Discount](Discount.mdx)>` Gets a discount by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)> @@ -1064,13 +1050,13 @@ Promise<[Discount](Discount.mdx)> ___ -### retrieveByCode +#### retrieveByCode `**retrieveByCode**(discountCode, config?): Promise<[Discount](Discount.mdx)>` Gets the discount by discount code. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)> @@ -1111,11 +1097,11 @@ Promise<[Discount](Discount.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1147,13 +1133,13 @@ ___ ___ -### update +#### update `**update**(discountId, update): Promise<[Discount](Discount.mdx)>` Updates a discount. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Discount](Discount.mdx)> @@ -1194,11 +1180,11 @@ Promise<[Discount](Discount.mdx)> ___ -### validateDiscountForCartOrThrow +#### validateDiscountForCartOrThrow `**validateDiscountForCartOrThrow**(cart, discount): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1239,11 +1225,11 @@ Promise<void> ___ -### validateDiscountForProduct +#### validateDiscountForProduct `**validateDiscountForProduct**(discountRuleId, productId?): Promise<boolean>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -1284,12 +1270,14 @@ Promise<boolean> ___ -### validateDiscountRule\_ +#### validateDiscountRule\_ `**validateDiscountRule_**(discountRule): T` Creates a discount rule with provided data given that the data is validated. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `T` - + ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [DiscountService](DiscountService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [DiscountService](DiscountService.mdx) diff --git a/www/apps/docs/content/references/services/classes/DraftOrder.mdx b/www/apps/docs/content/references/services/classes/DraftOrder.mdx index 2424a06991..91fa45b752 100644 --- a/www/apps/docs/content/references/services/classes/DraftOrder.mdx +++ b/www/apps/docs/content/references/services/classes/DraftOrder.mdx @@ -10,7 +10,7 @@ A draft order is created by an admin without direct involvement of the customer. ## Constructors -### constructor +#### constructor `**new DraftOrder**()` @@ -149,11 +149,11 @@ A draft order is created by an admin without direct involvement of the customer. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): Promise<void>` -#### Returns +##### Returns Promise<void> diff --git a/www/apps/docs/content/references/services/classes/DraftOrderService.mdx b/www/apps/docs/content/references/services/classes/DraftOrderService.mdx index 6deb4733d6..504f3aa8f4 100644 --- a/www/apps/docs/content/references/services/classes/DraftOrderService.mdx +++ b/www/apps/docs/content/references/services/classes/DraftOrderService.mdx @@ -12,11 +12,11 @@ Handles draft orders ## Constructors -### constructor +#### constructor `**new DraftOrderService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -220,6 +204,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -291,13 +277,13 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[DraftOrder](DraftOrder.mdx)>` Creates a draft order. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[DraftOrder](DraftOrder.mdx)> @@ -329,13 +315,13 @@ Promise<[DraftOrder](DraftOrder.mdx)> ___ -### delete +#### delete `**delete**(draftOrderId): Promise<undefined \| [DraftOrder](DraftOrder.mdx)>` Deletes draft order idempotently. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| [DraftOrder](DraftOrder.mdx)> @@ -367,13 +353,13 @@ Promise<undefined \| [DraftOrder](DraftOrder.mdx)> ___ -### list +#### list `**list**(selector, config?): Promise<[DraftOrder](DraftOrder.mdx)[]>` Lists draft orders -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[DraftOrder](DraftOrder.mdx)[]> @@ -414,13 +400,13 @@ Promise<[DraftOrder](DraftOrder.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[DraftOrder](DraftOrder.mdx)[], number]>` Lists draft orders alongside the count -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[DraftOrder](DraftOrder.mdx)[], number]> @@ -461,13 +447,13 @@ Promise<[[DraftOrder](DraftOrder.mdx)[], number]> ___ -### registerCartCompletion +#### registerCartCompletion `**registerCartCompletion**(draftOrderId, orderId): Promise<UpdateResult>` Registers a draft order as completed, when an order has been completed. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<UpdateResult> @@ -508,13 +494,13 @@ Promise<UpdateResult> ___ -### retrieve +#### retrieve `**retrieve**(draftOrderId, config?): Promise<[DraftOrder](DraftOrder.mdx)>` Retrieves a draft order with the given id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[DraftOrder](DraftOrder.mdx)> @@ -555,13 +541,13 @@ Promise<[DraftOrder](DraftOrder.mdx)> ___ -### retrieveByCartId +#### retrieveByCartId `**retrieveByCartId**(cartId, config?): Promise<[DraftOrder](DraftOrder.mdx)>` Retrieves a draft order based on its associated cart id -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[DraftOrder](DraftOrder.mdx)> @@ -602,11 +588,11 @@ Promise<[DraftOrder](DraftOrder.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -638,13 +624,13 @@ ___ ___ -### update +#### update `**update**(id, data): Promise<[DraftOrder](DraftOrder.mdx)>` Updates a draft order with the given data -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[DraftOrder](DraftOrder.mdx)> @@ -694,11 +680,11 @@ Promise<[DraftOrder](DraftOrder.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [DraftOrderService](DraftOrderService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [DraftOrderService](DraftOrderService.mdx) diff --git a/www/apps/docs/content/references/services/classes/EventBusService.mdx b/www/apps/docs/content/references/services/classes/EventBusService.mdx index c1da5707ba..48ad4920d5 100644 --- a/www/apps/docs/content/references/services/classes/EventBusService.mdx +++ b/www/apps/docs/content/references/services/classes/EventBusService.mdx @@ -15,11 +15,11 @@ subscribers when events happen. Events will run asynchronously. ## Constructors -### constructor +#### constructor `**new EventBusService**(«destructured», config, isSingleton?)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ___ -### eventBusModuleService\_ +#### eventBusModuleService\_ -`Protected get**eventBusModuleService_**(): [IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)` - -#### Returns - -[IEventBusModuleService](../interfaces/IEventBusModuleService.mdx) - - + `Protected` **eventBusModuleService\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -200,6 +168,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -271,12 +241,14 @@ Promise<TResult> ___ -### emit +#### emit `**emit**(data): Promise<void \| [StagedJob](StagedJob.mdx)[]>` Calls all subscribers when an event occurs. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [StagedJob](StagedJob.mdx)[]> @@ -323,6 +295,8 @@ Promise<void \| [StagedJob](StagedJob.mdx)[]> Calls all subscribers when an event occurs. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [StagedJob](StagedJob.mdx)> @@ -385,11 +359,11 @@ Promise<void \| [StagedJob](StagedJob.mdx)> ___ -### enqueuer\_ +#### enqueuer\_ `**enqueuer_**(): Promise<void>` -#### Returns +##### Returns Promise<void> @@ -407,11 +381,11 @@ Promise<void> ___ -### listJobs +#### listJobs `Protected **listJobs**(listConfig): Promise<never[] \| [StagedJob](StagedJob.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<never[] \| [StagedJob](StagedJob.mdx)[]> @@ -443,11 +417,11 @@ Promise<never[] \| [StagedJob](StagedJob.mdx)[]> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -479,11 +453,11 @@ ___ ___ -### startEnqueuer +#### startEnqueuer `**startEnqueuer**(): void` -#### Returns +##### Returns `void` @@ -501,11 +475,11 @@ ___ ___ -### stopEnqueuer +#### stopEnqueuer `**stopEnqueuer**(): Promise<void>` -#### Returns +##### Returns Promise<void> @@ -523,13 +497,13 @@ Promise<void> ___ -### subscribe +#### subscribe `**subscribe**(event, subscriber, context?): [EventBusService](EventBusService.mdx)` Adds a function to a list of event subscribers. -#### Parameters +##### Parameters -#### Returns +##### Returns [EventBusService](EventBusService.mdx) @@ -579,13 +553,13 @@ Adds a function to a list of event subscribers. ___ -### unsubscribe +#### unsubscribe `**unsubscribe**(event, subscriber, context): [EventBusService](EventBusService.mdx)` Removes function from the list of event subscribers. -#### Parameters +##### Parameters -#### Returns +##### Returns [EventBusService](EventBusService.mdx) @@ -635,11 +609,11 @@ Removes function from the list of event subscribers. ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [EventBusService](EventBusService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [EventBusService](EventBusService.mdx) diff --git a/www/apps/docs/content/references/services/classes/FilterableBatchJobProps.mdx b/www/apps/docs/content/references/services/classes/FilterableBatchJobProps.mdx index 6cf6a45803..8eb79316a3 100644 --- a/www/apps/docs/content/references/services/classes/FilterableBatchJobProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterableBatchJobProps.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new FilterableBatchJobProps**()` diff --git a/www/apps/docs/content/references/services/classes/FilterableCartProps.mdx b/www/apps/docs/content/references/services/classes/FilterableCartProps.mdx index 514104ab67..9117f73a88 100644 --- a/www/apps/docs/content/references/services/classes/FilterableCartProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterableCartProps.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new FilterableCartProps**()` diff --git a/www/apps/docs/content/references/services/classes/FilterableDiscountProps.mdx b/www/apps/docs/content/references/services/classes/FilterableDiscountProps.mdx index 48604e057d..316245b411 100644 --- a/www/apps/docs/content/references/services/classes/FilterableDiscountProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterableDiscountProps.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new FilterableDiscountProps**()` diff --git a/www/apps/docs/content/references/services/classes/FilterableLineItemAdjustmentProps.mdx b/www/apps/docs/content/references/services/classes/FilterableLineItemAdjustmentProps.mdx index 36b9b08351..b5b38a6278 100644 --- a/www/apps/docs/content/references/services/classes/FilterableLineItemAdjustmentProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterableLineItemAdjustmentProps.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new FilterableLineItemAdjustmentProps**()` diff --git a/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx b/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx index a8ba1db384..1b8d27cf30 100644 --- a/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx @@ -10,7 +10,7 @@ Filters to apply on the retrieved price lists. ## Constructors -### constructor +#### constructor `**new FilterablePriceListProps**()` diff --git a/www/apps/docs/content/references/services/classes/FilterableProductProps.mdx b/www/apps/docs/content/references/services/classes/FilterableProductProps.mdx index bddd60902e..171fe2bba2 100644 --- a/www/apps/docs/content/references/services/classes/FilterableProductProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterableProductProps.mdx @@ -10,7 +10,7 @@ Filters to apply on retrieved products. ## Constructors -### constructor +#### constructor `**new FilterableProductProps**()` diff --git a/www/apps/docs/content/references/services/classes/FilterableProductVariantProps.mdx b/www/apps/docs/content/references/services/classes/FilterableProductVariantProps.mdx index d071c6de4e..486014c0df 100644 --- a/www/apps/docs/content/references/services/classes/FilterableProductVariantProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterableProductVariantProps.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new FilterableProductVariantProps**()` diff --git a/www/apps/docs/content/references/services/classes/FlagRouter.mdx b/www/apps/docs/content/references/services/classes/FlagRouter.mdx index d892d1c82e..1c96f28e56 100644 --- a/www/apps/docs/content/references/services/classes/FlagRouter.mdx +++ b/www/apps/docs/content/references/services/classes/FlagRouter.mdx @@ -12,11 +12,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new FlagRouter**(flags)` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -90,11 +90,11 @@ An example of a nested flag is workflows. To use it, you would do: ___ -### listFlags +#### listFlags `**listFlags**(): [FeatureFlagsResponse](../types/FeatureFlagsResponse.mdx)` -#### Returns +##### Returns [FeatureFlagsResponse](../types/FeatureFlagsResponse.mdx) @@ -112,7 +112,7 @@ ___ ___ -### setFlag +#### setFlag `**setFlag**(key, value): void` @@ -122,7 +122,7 @@ Flags take two shapes: `setFlag("myFeatureFlag", { nestedFlag: true })` These shapes are used for top-level and nested flags respectively, as explained in isFeatureEnabled. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/Fulfillment.mdx b/www/apps/docs/content/references/services/classes/Fulfillment.mdx index 9ef547999c..aef95de217 100644 --- a/www/apps/docs/content/references/services/classes/Fulfillment.mdx +++ b/www/apps/docs/content/references/services/classes/Fulfillment.mdx @@ -10,7 +10,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm ## Constructors -### constructor +#### constructor `**new Fulfillment**()` @@ -212,11 +212,11 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/FulfillmentItem.mdx b/www/apps/docs/content/references/services/classes/FulfillmentItem.mdx index 93a30a3ec6..e4611e9608 100644 --- a/www/apps/docs/content/references/services/classes/FulfillmentItem.mdx +++ b/www/apps/docs/content/references/services/classes/FulfillmentItem.mdx @@ -10,7 +10,7 @@ This represents the association between a Line Item and a Fulfillment. ## Constructors -### constructor +#### constructor `**new FulfillmentItem**()` diff --git a/www/apps/docs/content/references/services/classes/FulfillmentProvider.mdx b/www/apps/docs/content/references/services/classes/FulfillmentProvider.mdx index ec69d81ac0..7f6fec5d81 100644 --- a/www/apps/docs/content/references/services/classes/FulfillmentProvider.mdx +++ b/www/apps/docs/content/references/services/classes/FulfillmentProvider.mdx @@ -10,7 +10,7 @@ A fulfillment provider represents a fulfillment service installed in the Medusa ## Constructors -### constructor +#### constructor `**new FulfillmentProvider**()` diff --git a/www/apps/docs/content/references/services/classes/FulfillmentProviderService.mdx b/www/apps/docs/content/references/services/classes/FulfillmentProviderService.mdx index 537b0adda7..fcce88213f 100644 --- a/www/apps/docs/content/references/services/classes/FulfillmentProviderService.mdx +++ b/www/apps/docs/content/references/services/classes/FulfillmentProviderService.mdx @@ -10,11 +10,11 @@ Helps retrieve fulfillment providers ## Constructors -### constructor +#### constructor `**new FulfillmentProviderService**(container)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -128,6 +112,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -199,11 +185,11 @@ Promise<TResult> ___ -### calculatePrice +#### calculatePrice `**calculatePrice**(option, data, cart?): Promise<number>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -253,11 +239,11 @@ Promise<number> ___ -### canCalculate +#### canCalculate `**canCalculate**(option): Promise<boolean>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -289,11 +275,11 @@ Promise<boolean> ___ -### cancelFulfillment +#### cancelFulfillment `**cancelFulfillment**(fulfillment): Promise<[Fulfillment](Fulfillment.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Fulfillment](Fulfillment.mdx)> @@ -325,11 +311,11 @@ Promise<[Fulfillment](Fulfillment.mdx)> ___ -### createFulfillment +#### createFulfillment `**createFulfillment**(method, items, order, fulfillment): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -388,11 +374,11 @@ Promise<Record<string, unknown>> ___ -### createReturn +#### createReturn `**createReturn**(returnOrder): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -424,11 +410,11 @@ Promise<Record<string, unknown>> ___ -### list +#### list `**list**(): Promise<[FulfillmentProvider](FulfillmentProvider.mdx)[]>` -#### Returns +##### Returns Promise<[FulfillmentProvider](FulfillmentProvider.mdx)[]> @@ -446,11 +432,11 @@ Promise<[FulfillmentProvider](FulfillmentProvider.mdx)[]> ___ -### listFulfillmentOptions +#### listFulfillmentOptions `**listFulfillmentOptions**(providerIds): Promise<[FulfillmentOptions](../types/FulfillmentOptions.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[FulfillmentOptions](../types/FulfillmentOptions.mdx)[]> @@ -482,11 +468,11 @@ Promise<[FulfillmentOptions](../types/FulfillmentOptions.mdx)[]> ___ -### registerInstalledProviders +#### registerInstalledProviders `**registerInstalledProviders**(providers): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -518,13 +504,13 @@ Promise<void> ___ -### retrieveDocuments +#### retrieveDocuments `**retrieveDocuments**(providerId, fulfillmentData, documentType): Promise<any>` Fetches documents from the fulfillment provider -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<any> @@ -574,11 +560,11 @@ Promise<any> ___ -### retrieveProvider +#### retrieveProvider `**retrieveProvider**(providerId): any` -#### Parameters +##### Parameters -#### Returns +##### Returns `any` @@ -610,11 +596,11 @@ ___ ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -646,11 +632,11 @@ ___ ___ -### validateFulfillmentData +#### validateFulfillmentData `**validateFulfillmentData**(option, data, cart): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -700,11 +686,11 @@ Promise<Record<string, unknown>> ___ -### validateOption +#### validateOption `**validateOption**(option): Promise<boolean>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -736,11 +722,11 @@ Promise<boolean> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [FulfillmentProviderService](FulfillmentProviderService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [FulfillmentProviderService](FulfillmentProviderService.mdx) diff --git a/www/apps/docs/content/references/services/classes/FulfillmentService.mdx b/www/apps/docs/content/references/services/classes/FulfillmentService.mdx index bd39bc2308..ff92356a92 100644 --- a/www/apps/docs/content/references/services/classes/FulfillmentService.mdx +++ b/www/apps/docs/content/references/services/classes/FulfillmentService.mdx @@ -10,11 +10,11 @@ Handles Fulfillments ## Constructors -### constructor +#### constructor `**new FulfillmentService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -182,6 +166,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -253,7 +239,7 @@ Promise<TResult> ___ -### cancelFulfillment +#### cancelFulfillment `**cancelFulfillment**(fulfillmentOrId): Promise<[Fulfillment](Fulfillment.mdx)>` @@ -261,7 +247,7 @@ Cancels a fulfillment with the fulfillment provider. Will decrement the fulfillment\_quantity on the line items associated with the fulfillment. Throws if the fulfillment has already been shipped. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Fulfillment](Fulfillment.mdx)> @@ -293,7 +279,7 @@ Promise<[Fulfillment](Fulfillment.mdx)> ___ -### createFulfillment +#### createFulfillment `**createFulfillment**(order, itemsToFulfill, custom?): Promise<[Fulfillment](Fulfillment.mdx)[]>` @@ -302,7 +288,7 @@ If items needs to be fulfilled by different provider, we make sure to partition those items, and create fulfillment for those partitions. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Fulfillment](Fulfillment.mdx)[]> @@ -352,14 +338,14 @@ Promise<[Fulfillment](Fulfillment.mdx)[]> ___ -### createShipment +#### createShipment `**createShipment**(fulfillmentId, trackingLinks?, config?): Promise<[Fulfillment](Fulfillment.mdx)>` Creates a shipment by marking a fulfillment as shipped. Adds tracking links and potentially more metadata. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Fulfillment](Fulfillment.mdx)> @@ -409,13 +395,13 @@ Promise<[Fulfillment](Fulfillment.mdx)> ___ -### getFulfillmentItems\_ +#### getFulfillmentItems\_ `**getFulfillmentItems_**(order, items): Promise<(null \| [LineItem](LineItem.mdx))[]>` Retrieves the order line items, given an array of items. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<(null \| [LineItem](LineItem.mdx))[]> @@ -456,11 +442,11 @@ Promise<(null \| [LineItem](LineItem.mdx))[]> ___ -### partitionItems\_ +#### partitionItems\_ `**partitionItems_**(shippingMethods, items): [FulfillmentItemPartition](../types/FulfillmentItemPartition.mdx)[]` -#### Parameters +##### Parameters -#### Returns +##### Returns [FulfillmentItemPartition](../types/FulfillmentItemPartition.mdx)[] @@ -501,13 +487,13 @@ ___ ___ -### retrieve +#### retrieve `**retrieve**(fulfillmentId, config?): Promise<[Fulfillment](Fulfillment.mdx)>` Retrieves a fulfillment by its id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Fulfillment](Fulfillment.mdx)> @@ -548,11 +534,11 @@ Promise<[Fulfillment](Fulfillment.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -584,7 +570,7 @@ ___ ___ -### validateFulfillmentLineItem\_ +#### validateFulfillmentLineItem\_ `**validateFulfillmentLineItem_**(item, quantity): null \| [LineItem](LineItem.mdx)` @@ -593,7 +579,7 @@ fulfillable quantity is lower than the requested fulfillment quantity. Fulfillable quantity is calculated by subtracting the already fulfilled quantity from the quantity that was originally purchased. -#### Parameters +##### Parameters -#### Returns +##### Returns `null` \| [LineItem](LineItem.mdx) @@ -634,11 +620,11 @@ quantity from the quantity that was originally purchased. ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [FulfillmentService](FulfillmentService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [FulfillmentService](FulfillmentService.mdx) diff --git a/www/apps/docs/content/references/services/classes/GiftCard-1.mdx b/www/apps/docs/content/references/services/classes/GiftCard-1.mdx index f4094d8b92..e104149f30 100644 --- a/www/apps/docs/content/references/services/classes/GiftCard-1.mdx +++ b/www/apps/docs/content/references/services/classes/GiftCard-1.mdx @@ -10,7 +10,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay ## Constructors -### constructor +#### constructor `**new GiftCard**()` diff --git a/www/apps/docs/content/references/services/classes/GiftCard.mdx b/www/apps/docs/content/references/services/classes/GiftCard.mdx index 4dc5133cff..a15cac689c 100644 --- a/www/apps/docs/content/references/services/classes/GiftCard.mdx +++ b/www/apps/docs/content/references/services/classes/GiftCard.mdx @@ -10,7 +10,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay ## Constructors -### constructor +#### constructor `**new GiftCard**()` @@ -158,11 +158,11 @@ Gift Cards are redeemable and represent a value that can be used towards the pay ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/GiftCardService.mdx b/www/apps/docs/content/references/services/classes/GiftCardService.mdx index 39c3e0aa2e..3f593ab311 100644 --- a/www/apps/docs/content/references/services/classes/GiftCardService.mdx +++ b/www/apps/docs/content/references/services/classes/GiftCardService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate gift cards. ## Constructors -### constructor +#### constructor `**new GiftCardService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -164,6 +148,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -235,13 +221,13 @@ Promise<TResult> ___ -### create +#### create `**create**(giftCard): Promise<[GiftCard](GiftCard.mdx)>` Creates a gift card with provided data given that the data is validated. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GiftCard](GiftCard.mdx)> @@ -273,11 +259,11 @@ Promise<[GiftCard](GiftCard.mdx)> ___ -### createTransaction +#### createTransaction `**createTransaction**(data): Promise<string>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string> @@ -309,13 +295,13 @@ Promise<string> ___ -### delete +#### delete `**delete**(giftCardId): Promise<void \| [GiftCard](GiftCard.mdx)>` Deletes a gift card idempotently -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [GiftCard](GiftCard.mdx)> @@ -347,11 +333,11 @@ Promise<void \| [GiftCard](GiftCard.mdx)> ___ -### list +#### list `**list**(selector?, config?): Promise<[GiftCard](GiftCard.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GiftCard](GiftCard.mdx)[]> @@ -392,11 +378,11 @@ Promise<[GiftCard](GiftCard.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config?): Promise<[[GiftCard](GiftCard.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[GiftCard](GiftCard.mdx)[], number]> @@ -437,13 +423,13 @@ Promise<[[GiftCard](GiftCard.mdx)[], number]> ___ -### retrieve +#### retrieve `**retrieve**(giftCardId, config?): Promise<[GiftCard](GiftCard.mdx)>` Gets a gift card by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GiftCard](GiftCard.mdx)> @@ -484,11 +470,11 @@ Promise<[GiftCard](GiftCard.mdx)> ___ -### retrieveByCode +#### retrieveByCode `**retrieveByCode**(code, config?): Promise<[GiftCard](GiftCard.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GiftCard](GiftCard.mdx)> @@ -529,11 +515,11 @@ Promise<[GiftCard](GiftCard.mdx)> ___ -### retrieve\_ +#### retrieve\_ `Protected **retrieve_**(selector, config?): Promise<[GiftCard](GiftCard.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GiftCard](GiftCard.mdx)> @@ -574,11 +560,11 @@ Promise<[GiftCard](GiftCard.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -610,13 +596,13 @@ ___ ___ -### update +#### update `**update**(giftCardId, update): Promise<[GiftCard](GiftCard.mdx)>` Updates a giftCard. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GiftCard](GiftCard.mdx)> @@ -657,11 +643,11 @@ Promise<[GiftCard](GiftCard.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [GiftCardService](GiftCardService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [GiftCardService](GiftCardService.mdx) @@ -693,13 +679,13 @@ ___ ___ -### generateCode +#### generateCode `Static **generateCode**(): string` Generates a 16 character gift card code -#### Returns +##### Returns `string` @@ -717,14 +703,14 @@ Generates a 16 character gift card code ___ -### resolveTaxRate +#### resolveTaxRate `Static Protected **resolveTaxRate**(giftCardTaxRate, region): null \| number` The tax\_rate of the giftcard can depend on whether regions tax gift cards, an input provided by the user or the tax rate. Based on these conditions, tax\_rate changes. -#### Parameters +##### Parameters -#### Returns +##### Returns `null` \| `number` diff --git a/www/apps/docs/content/references/services/classes/GiftCardTransaction.mdx b/www/apps/docs/content/references/services/classes/GiftCardTransaction.mdx index 2b81e78f67..d2a059eeb2 100644 --- a/www/apps/docs/content/references/services/classes/GiftCardTransaction.mdx +++ b/www/apps/docs/content/references/services/classes/GiftCardTransaction.mdx @@ -10,7 +10,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t ## Constructors -### constructor +#### constructor `**new GiftCardTransaction**()` @@ -104,11 +104,11 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/IdempotencyKey.mdx b/www/apps/docs/content/references/services/classes/IdempotencyKey.mdx index 7cf15a76a4..91d4e0e08f 100644 --- a/www/apps/docs/content/references/services/classes/IdempotencyKey.mdx +++ b/www/apps/docs/content/references/services/classes/IdempotencyKey.mdx @@ -10,7 +10,7 @@ Idempotency Key is used to continue a process in case of any failure that might ## Constructors -### constructor +#### constructor `**new IdempotencyKey**()` @@ -113,11 +113,11 @@ Idempotency Key is used to continue a process in case of any failure that might ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/IdempotencyKeyService.mdx b/www/apps/docs/content/references/services/classes/IdempotencyKeyService.mdx index 396aabb5fd..0012f57d9b 100644 --- a/www/apps/docs/content/references/services/classes/IdempotencyKeyService.mdx +++ b/www/apps/docs/content/references/services/classes/IdempotencyKeyService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new IdempotencyKeyService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -117,6 +101,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -188,7 +174,7 @@ Promise<TResult> ___ -### create +#### create `**create**(payload): Promise<[IdempotencyKey](IdempotencyKey.mdx)>` @@ -196,7 +182,7 @@ Creates an idempotency key for a request. If no idempotency key is provided in request, we will create a unique identifier. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[IdempotencyKey](IdempotencyKey.mdx)> @@ -228,13 +214,13 @@ Promise<[IdempotencyKey](IdempotencyKey.mdx)> ___ -### initializeRequest +#### initializeRequest `**initializeRequest**(headerKey, reqMethod, reqParams, reqPath): Promise<[IdempotencyKey](IdempotencyKey.mdx)>` Execute the initial steps in a idempotent request. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[IdempotencyKey](IdempotencyKey.mdx)> @@ -293,13 +279,13 @@ Promise<[IdempotencyKey](IdempotencyKey.mdx)> ___ -### lock +#### lock `**lock**(idempotencyKey): Promise<[IdempotencyKey](IdempotencyKey.mdx)>` Locks an idempotency. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[IdempotencyKey](IdempotencyKey.mdx)> @@ -331,13 +317,13 @@ Promise<[IdempotencyKey](IdempotencyKey.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(idempotencyKeyOrSelector): Promise<[IdempotencyKey](IdempotencyKey.mdx)>` Retrieves an idempotency key -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[IdempotencyKey](IdempotencyKey.mdx)> @@ -369,11 +355,11 @@ Promise<[IdempotencyKey](IdempotencyKey.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -405,13 +391,13 @@ ___ ___ -### update +#### update `**update**(idempotencyKey, update): Promise<[IdempotencyKey](IdempotencyKey.mdx)>` Locks an idempotency. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[IdempotencyKey](IdempotencyKey.mdx)> @@ -452,11 +438,11 @@ Promise<[IdempotencyKey](IdempotencyKey.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [IdempotencyKeyService](IdempotencyKeyService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IdempotencyKeyService](IdempotencyKeyService.mdx) @@ -488,7 +474,7 @@ ___ ___ -### workStage +#### workStage `**workStage**(idempotencyKey, callback): Promise<[IdempotencyKey](IdempotencyKey.mdx)>` @@ -498,7 +484,7 @@ transactionally executed in isolation. An idempotent request will always consist of 2 or more of these phases. The required phases are "started" and "finished". -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[IdempotencyKey](IdempotencyKey.mdx)> diff --git a/www/apps/docs/content/references/services/classes/Image.mdx b/www/apps/docs/content/references/services/classes/Image.mdx index e573d5a78f..590d39216e 100644 --- a/www/apps/docs/content/references/services/classes/Image.mdx +++ b/www/apps/docs/content/references/services/classes/Image.mdx @@ -10,7 +10,7 @@ An Image is used to store details about uploaded images. Images are uploaded by ## Constructors -### constructor +#### constructor `**new Image**()` @@ -77,11 +77,11 @@ An Image is used to store details about uploaded images. Images are uploaded by ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/LineItem.mdx b/www/apps/docs/content/references/services/classes/LineItem.mdx index 5e1cdbc423..9797b8b4b6 100644 --- a/www/apps/docs/content/references/services/classes/LineItem.mdx +++ b/www/apps/docs/content/references/services/classes/LineItem.mdx @@ -10,7 +10,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu ## Constructors -### constructor +#### constructor `**new LineItem**()` @@ -411,11 +411,11 @@ Line Items are created when a product is added to a Cart. When Line Items are pu ## Methods -### afterUpdateOrLoad +#### afterUpdateOrLoad `**afterUpdateOrLoad**(): void` -#### Returns +##### Returns `void` @@ -433,11 +433,11 @@ Line Items are created when a product is added to a Cart. When Line Items are pu ___ -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` @@ -455,11 +455,11 @@ ___ ___ -### beforeUpdate +#### beforeUpdate `**beforeUpdate**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/LineItemAdjustment.mdx b/www/apps/docs/content/references/services/classes/LineItemAdjustment.mdx index 29eb7090c5..4053d73a15 100644 --- a/www/apps/docs/content/references/services/classes/LineItemAdjustment.mdx +++ b/www/apps/docs/content/references/services/classes/LineItemAdjustment.mdx @@ -10,7 +10,7 @@ A Line Item Adjustment includes details on discounts applied on a line item. ## Constructors -### constructor +#### constructor `**new LineItemAdjustment**()` @@ -95,11 +95,11 @@ A Line Item Adjustment includes details on discounts applied on a line item. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx b/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx index 63734041db..0a0744164b 100644 --- a/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx +++ b/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate line item adjustments. ## Constructors -### constructor +#### constructor `**new LineItemAdjustmentService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -128,6 +112,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -199,13 +185,13 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[LineItemAdjustment](LineItemAdjustment.mdx)>` Creates a line item adjustment -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemAdjustment](LineItemAdjustment.mdx)> @@ -237,13 +223,13 @@ Promise<[LineItemAdjustment](LineItemAdjustment.mdx)> ___ -### createAdjustmentForLineItem +#### createAdjustmentForLineItem `**createAdjustmentForLineItem**(cart, lineItem): Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[]>` Creates adjustment for a line item -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[]> @@ -284,13 +270,13 @@ Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[]> ___ -### createAdjustments +#### createAdjustments `**createAdjustments**(cart, lineItem?): Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[] \| [LineItemAdjustment](LineItemAdjustment.mdx)[][]>` Creates adjustment for a line item -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[] \| [LineItemAdjustment](LineItemAdjustment.mdx)[][]> @@ -331,13 +317,13 @@ Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[] \| [LineItemAdjustmen ___ -### delete +#### delete `**delete**(selectorOrIds): Promise<void>` Deletes line item adjustments matching a selector -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -369,13 +355,13 @@ Promise<void> ___ -### generateAdjustments +#### generateAdjustments `**generateAdjustments**(calculationContextData, generatedLineItem, context): Promise<[GeneratedAdjustment](../types/GeneratedAdjustment.mdx)[]>` Creates adjustment for a line item -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GeneratedAdjustment](../types/GeneratedAdjustment.mdx)[]> @@ -425,13 +411,13 @@ Promise<[GeneratedAdjustment](../types/GeneratedAdjustment.mdx)[]> ___ -### list +#### list `**list**(selector?, config?): Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[]>` Lists line item adjustments -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[]> @@ -472,13 +458,13 @@ Promise<[LineItemAdjustment](LineItemAdjustment.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(lineItemAdjustmentId, config?): Promise<[LineItemAdjustment](LineItemAdjustment.mdx)>` Retrieves a line item adjustment by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemAdjustment](LineItemAdjustment.mdx)> @@ -519,11 +505,11 @@ Promise<[LineItemAdjustment](LineItemAdjustment.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -555,13 +541,13 @@ ___ ___ -### update +#### update `**update**(id, data): Promise<[LineItemAdjustment](LineItemAdjustment.mdx)>` Creates a line item adjustment -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemAdjustment](LineItemAdjustment.mdx)> @@ -602,11 +588,11 @@ Promise<[LineItemAdjustment](LineItemAdjustment.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [LineItemAdjustmentService](LineItemAdjustmentService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [LineItemAdjustmentService](LineItemAdjustmentService.mdx) diff --git a/www/apps/docs/content/references/services/classes/LineItemService.mdx b/www/apps/docs/content/references/services/classes/LineItemService.mdx index 6b040c9275..ac99cdbd5e 100644 --- a/www/apps/docs/content/references/services/classes/LineItemService.mdx +++ b/www/apps/docs/content/references/services/classes/LineItemService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new LineItemService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -198,6 +182,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -269,11 +255,11 @@ Promise<TResult> ___ -### cloneTo +#### cloneTo `**cloneTo**(ids, data?, options?): Promise<[LineItem](LineItem.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx)[]> @@ -332,12 +318,14 @@ Promise<[LineItem](LineItem.mdx)[]> ___ -### create +#### create `**create**(data): Promise<TResult>` Create a line item +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -391,14 +379,14 @@ Promise<TResult> ___ -### createReturnLines +#### createReturnLines `**createReturnLines**(returnId, cartId): Promise<[LineItem](LineItem.mdx)[]>` Creates return line items for a given cart based on the return items in a return. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx)[]> @@ -439,13 +427,13 @@ Promise<[LineItem](LineItem.mdx)[]> ___ -### createTaxLine +#### createTaxLine `**createTaxLine**(args): [LineItemTaxLine](LineItemTaxLine.mdx)` Create a line item tax line. -#### Parameters +##### Parameters -#### Returns +##### Returns [LineItemTaxLine](LineItemTaxLine.mdx) @@ -477,13 +465,13 @@ Create a line item tax line. ___ -### delete +#### delete `**delete**(id): Promise<undefined \| null \| [LineItem](LineItem.mdx)>` Deletes a line item. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| null \| [LineItem](LineItem.mdx)> @@ -515,11 +503,11 @@ Promise<undefined \| null \| [LineItem](LineItem.mdx)> ___ -### deleteWithTaxLines +#### deleteWithTaxLines `**deleteWithTaxLines**(id): Promise<undefined \| null \| [LineItem](LineItem.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| null \| [LineItem](LineItem.mdx)> @@ -556,12 +544,14 @@ Deletes a line item with the tax lines. ___ -### generate +#### generate `**generate**(variantIdOrData, regionIdOrContext, quantity?, context?): Promise<TResult>` Generate a single or multiple line item without persisting the data into the db +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -642,11 +632,11 @@ Promise<TResult> ___ -### generateLineItem +#### generateLineItem `Protected **generateLineItem**(variant, quantity, context): Promise<[LineItem](LineItem.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx)> @@ -768,11 +758,11 @@ Promise<[LineItem](LineItem.mdx)> ___ -### list +#### list `**list**(selector, config?): Promise<[LineItem](LineItem.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx)[]> @@ -813,13 +803,13 @@ Promise<[LineItem](LineItem.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(id, config?): Promise<[LineItem](LineItem.mdx)>` Retrieves a line item by its id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx)> @@ -860,11 +850,11 @@ Promise<[LineItem](LineItem.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -896,13 +886,13 @@ ___ ___ -### update +#### update `**update**(idOrSelector, data): Promise<[LineItem](LineItem.mdx)[]>` Updates a line item -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx)[]> @@ -943,10 +933,12 @@ Promise<[LineItem](LineItem.mdx)[]> ___ -### validateGenerateArguments +#### validateGenerateArguments `Protected **validateGenerateArguments**(variantIdOrData, regionIdOrContext, quantity?): void` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -1018,11 +1010,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [LineItemService](LineItemService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [LineItemService](LineItemService.mdx) diff --git a/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx b/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx index b3cb91360b..fc56843383 100644 --- a/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx +++ b/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx @@ -10,7 +10,7 @@ A Line Item Tax Line represents the taxes applied on a line item. ## Constructors -### constructor +#### constructor `**new LineItemTaxLine**()` @@ -104,11 +104,11 @@ A Line Item Tax Line represents the taxes applied on a line item. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/MiddlewareService.mdx b/www/apps/docs/content/references/services/classes/MiddlewareService.mdx index 35e0b0a5c3..ecb3291a39 100644 --- a/www/apps/docs/content/references/services/classes/MiddlewareService.mdx +++ b/www/apps/docs/content/references/services/classes/MiddlewareService.mdx @@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API ## Constructors -### constructor +#### constructor `**new MiddlewareService**()` @@ -57,13 +57,13 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API ## Methods -### addPostAuthentication +#### addPostAuthentication `**addPostAuthentication**(middleware, options): void` Adds a middleware function to be called after authentication is completed. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -104,13 +104,13 @@ Adds a middleware function to be called after authentication is completed. ___ -### addPreAuthentication +#### addPreAuthentication `**addPreAuthentication**(middleware, options): void` Adds a middleware function to be called before authentication is completed. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -151,13 +151,13 @@ Adds a middleware function to be called before authentication is completed. ___ -### addPreCartCreation +#### addPreCartCreation `**addPreCartCreation**(middleware): void` Adds a middleware function to be called before cart creation -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -189,11 +189,11 @@ Adds a middleware function to be called before cart creation ___ -### addRouter +#### addRouter `**addRouter**(path, router): void` -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -234,11 +234,11 @@ ___ ___ -### getRouters +#### getRouters `**getRouters**(path): Router[]` -#### Parameters +##### Parameters -#### Returns +##### Returns Router[] @@ -270,13 +270,13 @@ Router[] ___ -### usePostAuthentication +#### usePostAuthentication `**usePostAuthentication**(app): void` Adds post authentication middleware to an express app. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -308,13 +308,13 @@ Adds post authentication middleware to an express app. ___ -### usePreAuthentication +#### usePreAuthentication `**usePreAuthentication**(app): void` Adds pre authentication middleware to an express app. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -346,11 +346,11 @@ Adds pre authentication middleware to an express app. ___ -### usePreCartCreation +#### usePreCartCreation `**usePreCartCreation**(): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]` -#### Returns +##### Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[] @@ -368,13 +368,13 @@ RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any& ___ -### validateMiddleware\_ +#### validateMiddleware\_ `**validateMiddleware_**(fn): void` Validates a middleware function, throws if fn is not of type function. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/MoneyAmount.mdx b/www/apps/docs/content/references/services/classes/MoneyAmount.mdx index 1077ec9279..294fbe8c34 100644 --- a/www/apps/docs/content/references/services/classes/MoneyAmount.mdx +++ b/www/apps/docs/content/references/services/classes/MoneyAmount.mdx @@ -10,7 +10,7 @@ A Money Amount represent a price amount, for example, a product variant's price ## Constructors -### constructor +#### constructor `**new MoneyAmount**()` @@ -120,7 +120,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "region_id", - "type": "`string`", + "type": "`null` \\| `string`", "description": "The region's ID", "optional": false, "defaultValue": "", @@ -167,11 +167,11 @@ A Money Amount represent a price amount, for example, a product variant's price ## Methods -### afterLoad +#### afterLoad `Private **afterLoad**(): void` -#### Returns +##### Returns `void` @@ -189,11 +189,11 @@ A Money Amount represent a price amount, for example, a product variant's price ___ -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): undefined \| void` -#### Returns +##### Returns `undefined` \| `void` @@ -211,11 +211,11 @@ ___ ___ -### beforeUpdate +#### beforeUpdate `Private **beforeUpdate**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/NewTotalsService.mdx b/www/apps/docs/content/references/services/classes/NewTotalsService.mdx index c361e7a3d1..a0d2eaa8d4 100644 --- a/www/apps/docs/content/references/services/classes/NewTotalsService.mdx +++ b/www/apps/docs/content/references/services/classes/NewTotalsService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new NewTotalsService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -135,6 +119,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -206,13 +192,13 @@ Promise<TResult> ___ -### getGiftCardTotals +#### getGiftCardTotals `**getGiftCardTotals**(giftCardableAmount, «destructured»): Promise<{ tax_total: number ; total: number }>` Calculate and return the gift cards totals -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ tax_total: number ; total: number }> @@ -280,13 +266,13 @@ Promise<{ tax_total: number ; total: number }> ___ -### getGiftCardTransactionsTotals +#### getGiftCardTransactionsTotals `**getGiftCardTransactionsTotals**(«destructured»): { tax_total: number ; total: number }` Calculate and return the gift cards totals based on their transactions -#### Parameters +##### Parameters -#### Returns +##### Returns `object` @@ -375,11 +361,11 @@ Calculate and return the gift cards totals based on their transactions ___ -### getGiftCardableAmount +#### getGiftCardableAmount `**getGiftCardableAmount**(«destructured»): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -456,13 +442,13 @@ ___ ___ -### getLineItemRefund +#### getLineItemRefund `**getLineItemRefund**(lineItem, «destructured»): number` Return the amount that can be refund on a line item -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -566,11 +552,11 @@ Return the amount that can be refund on a line item ___ -### getLineItemRefundLegacy +#### getLineItemRefundLegacy `Protected **getLineItemRefundLegacy**(lineItem, «destructured»): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -665,13 +651,13 @@ ___ ___ -### getLineItemTotals +#### getLineItemTotals `**getLineItemTotals**(items, «destructured»): Promise<{ [lineItemId: string]: [LineItemTotals](../types/LineItemTotals.mdx); }>` Calculate and return the items totals for either the legacy calculation or the new calculation -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ [lineItemId: string]: [LineItemTotals](../types/LineItemTotals.mdx); }> @@ -739,13 +725,13 @@ Promise<{ [lineItemId: string]: [LineItemTotals](../types/LineItemTotal ___ -### getLineItemTotalsLegacy +#### getLineItemTotalsLegacy `Protected **getLineItemTotalsLegacy**(item, «destructured»): Promise<[LineItemTotals](../types/LineItemTotals.mdx)>` Calculate and return the legacy calculated totals using the tax rate -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemTotals](../types/LineItemTotals.mdx)> @@ -831,13 +817,13 @@ Promise<[LineItemTotals](../types/LineItemTotals.mdx)> ___ -### getLineItemTotals\_ +#### getLineItemTotals\_ `Protected **getLineItemTotals_**(item, «destructured»): Promise<[LineItemTotals](../types/LineItemTotals.mdx)>` Calculate and return the totals for an item -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemTotals](../types/LineItemTotals.mdx)> @@ -932,13 +918,13 @@ Promise<[LineItemTotals](../types/LineItemTotals.mdx)> ___ -### getShippingMethodTotals +#### getShippingMethodTotals `**getShippingMethodTotals**(shippingMethods, «destructured»): Promise<{ [shippingMethodId: string]: [ShippingMethodTotals](../types/ShippingMethodTotals.mdx); }>` Calculate and return the shipping methods totals for either the legacy calculation or the new calculation -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ [shippingMethodId: string]: [ShippingMethodTotals](../types/ShippingMethodTotals.mdx); }> @@ -1015,13 +1001,13 @@ Promise<{ [shippingMethodId: string]: [ShippingMethodTotals](../types/S ___ -### getShippingMethodTotalsLegacy +#### getShippingMethodTotalsLegacy `Protected **getShippingMethodTotalsLegacy**(shippingMethod, «destructured»): Promise<[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)>` Calculate and return the shipping method totals legacy using the tax rate -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)> @@ -1089,13 +1075,13 @@ Promise<[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)> ___ -### getShippingMethodTotals\_ +#### getShippingMethodTotals\_ `Protected **getShippingMethodTotals_**(shippingMethod, «destructured»): Promise<[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)>` Calculate and return the shipping method totals -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)> @@ -1172,11 +1158,11 @@ Promise<[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1208,11 +1194,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [NewTotalsService](NewTotalsService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [NewTotalsService](NewTotalsService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Note.mdx b/www/apps/docs/content/references/services/classes/Note.mdx index ed4b30718f..b954da2819 100644 --- a/www/apps/docs/content/references/services/classes/Note.mdx +++ b/www/apps/docs/content/references/services/classes/Note.mdx @@ -10,7 +10,7 @@ A Note is an element that can be used in association with different resources to ## Constructors -### constructor +#### constructor `**new Note**()` @@ -113,11 +113,11 @@ A Note is an element that can be used in association with different resources to ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/NoteService.mdx b/www/apps/docs/content/references/services/classes/NoteService.mdx index 419d445a05..e043a7db0e 100644 --- a/www/apps/docs/content/references/services/classes/NoteService.mdx +++ b/www/apps/docs/content/references/services/classes/NoteService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new NoteService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -162,6 +146,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -233,13 +219,13 @@ Promise<TResult> ___ -### create +#### create `**create**(data, config?): Promise<[Note](Note.mdx)>` Creates a note associated with a given author -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Note](Note.mdx)> @@ -289,13 +275,13 @@ Promise<[Note](Note.mdx)> ___ -### delete +#### delete `**delete**(noteId): Promise<void>` Deletes a given note -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -327,13 +313,13 @@ Promise<void> ___ -### list +#### list `**list**(selector, config?): Promise<[Note](Note.mdx)[]>` Fetches all notes related to the given selector -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Note](Note.mdx)[]> @@ -374,13 +360,13 @@ Promise<[Note](Note.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Note](Note.mdx)[], number]>` Fetches all notes related to the given selector -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Note](Note.mdx)[], number]> @@ -421,13 +407,13 @@ Promise<[[Note](Note.mdx)[], number]> ___ -### retrieve +#### retrieve `**retrieve**(noteId, config?): Promise<[Note](Note.mdx)>` Retrieves a specific note. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Note](Note.mdx)> @@ -468,11 +454,11 @@ Promise<[Note](Note.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -504,13 +490,13 @@ ___ ___ -### update +#### update `**update**(noteId, value): Promise<[Note](Note.mdx)>` Updates a given note with a new value -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Note](Note.mdx)> @@ -551,11 +537,11 @@ Promise<[Note](Note.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [NoteService](NoteService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [NoteService](NoteService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Notification.mdx b/www/apps/docs/content/references/services/classes/Notification.mdx index 12c93616c1..1f8116d689 100644 --- a/www/apps/docs/content/references/services/classes/Notification.mdx +++ b/www/apps/docs/content/references/services/classes/Notification.mdx @@ -10,7 +10,7 @@ A notification is an alert sent, typically to customers, using the installed Not ## Constructors -### constructor +#### constructor `**new Notification**()` @@ -158,11 +158,11 @@ A notification is an alert sent, typically to customers, using the installed Not ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/NotificationProvider.mdx b/www/apps/docs/content/references/services/classes/NotificationProvider.mdx index 2533a49432..966c6f819d 100644 --- a/www/apps/docs/content/references/services/classes/NotificationProvider.mdx +++ b/www/apps/docs/content/references/services/classes/NotificationProvider.mdx @@ -10,7 +10,7 @@ A notification provider represents a notification service installed in the Medus ## Constructors -### constructor +#### constructor `**new NotificationProvider**()` diff --git a/www/apps/docs/content/references/services/classes/NotificationService.mdx b/www/apps/docs/content/references/services/classes/NotificationService.mdx index 0ea2ce4a4c..c63ad0b566 100644 --- a/www/apps/docs/content/references/services/classes/NotificationService.mdx +++ b/www/apps/docs/content/references/services/classes/NotificationService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new NotificationService**(container)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -162,6 +146,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -233,7 +219,7 @@ Promise<TResult> ___ -### handleEvent +#### handleEvent `**handleEvent**(eventName, data): Promise<undefined \| void \| [Notification](Notification.mdx)[]>` @@ -241,7 +227,7 @@ Handles an event by relaying the event data to the subscribing providers. The result of the notification send will be persisted in the database in order to allow for resends. Will log any errors that are encountered. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| void \| [Notification](Notification.mdx)[]> @@ -282,13 +268,13 @@ Promise<undefined \| void \| [Notification](Notification.mdx)[]> ___ -### list +#### list `**list**(selector, config?): Promise<[Notification](Notification.mdx)[]>` Retrieves a list of notifications. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Notification](Notification.mdx)[]> @@ -329,13 +315,13 @@ Promise<[Notification](Notification.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Notification](Notification.mdx)[], number]>` Retrieves a list of notifications and total count. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Notification](Notification.mdx)[], number]> @@ -376,14 +362,14 @@ Promise<[[Notification](Notification.mdx)[], number]> ___ -### registerAttachmentGenerator +#### registerAttachmentGenerator `**registerAttachmentGenerator**(service): void` Registers an attachment generator to the service. The generator can be used to generate on demand invoices or other documents. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -415,13 +401,13 @@ used to generate on demand invoices or other documents. ___ -### registerInstalledProviders +#### registerInstalledProviders `**registerInstalledProviders**(providerIds): Promise<void>` Takes a list of notification provider ids and persists them in the database. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -453,14 +439,14 @@ Promise<void> ___ -### resend +#### resend `**resend**(id, config?): Promise<[Notification](Notification.mdx)>` Resends a notification by retrieving a prior notification and calling the underlying provider's resendNotification method. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Notification](Notification.mdx)> @@ -501,13 +487,13 @@ Promise<[Notification](Notification.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(id, config?): Promise<[Notification](Notification.mdx)>` Retrieves a notification with a given id -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Notification](Notification.mdx)> @@ -548,14 +534,14 @@ Promise<[Notification](Notification.mdx)> ___ -### retrieveProvider\_ +#### retrieveProvider\_ `Protected **retrieveProvider_**(id): [AbstractNotificationService](AbstractNotificationService.mdx)` Finds a provider with a given id. Will throw a NOT\_FOUND error if the resolution fails. -#### Parameters +##### Parameters -#### Returns +##### Returns [AbstractNotificationService](AbstractNotificationService.mdx) @@ -587,14 +573,14 @@ resolution fails. ___ -### send +#### send `**send**(event, eventData, providerId): Promise<undefined \| [Notification](Notification.mdx)>` Sends a notification, by calling the given provider's sendNotification method. Persists the Notification in the database. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| [Notification](Notification.mdx)> @@ -644,11 +630,11 @@ Promise<undefined \| [Notification](Notification.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -680,13 +666,13 @@ ___ ___ -### subscribe +#### subscribe `**subscribe**(eventName, providerId): void` Subscribes a given provider to an event. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -727,11 +713,11 @@ Subscribes a given provider to an event. ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [NotificationService](NotificationService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [NotificationService](NotificationService.mdx) diff --git a/www/apps/docs/content/references/services/classes/NumericalComparisonOperator.mdx b/www/apps/docs/content/references/services/classes/NumericalComparisonOperator.mdx index 555e16a1ae..c9dfe796cd 100644 --- a/www/apps/docs/content/references/services/classes/NumericalComparisonOperator.mdx +++ b/www/apps/docs/content/references/services/classes/NumericalComparisonOperator.mdx @@ -10,7 +10,7 @@ Fields used to apply flexible filters on numbers. ## Constructors -### constructor +#### constructor `**new NumericalComparisonOperator**()` diff --git a/www/apps/docs/content/references/services/classes/Oauth.mdx b/www/apps/docs/content/references/services/classes/Oauth.mdx index 9184e5838e..f95706db16 100644 --- a/www/apps/docs/content/references/services/classes/Oauth.mdx +++ b/www/apps/docs/content/references/services/classes/Oauth.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new Oauth**()` @@ -73,11 +73,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/OauthService.mdx b/www/apps/docs/content/references/services/classes/OauthService.mdx index c8d2852f42..deb8ee7245 100644 --- a/www/apps/docs/content/references/services/classes/OauthService.mdx +++ b/www/apps/docs/content/references/services/classes/OauthService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new OauthService**(cradle)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -162,6 +146,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -233,11 +219,11 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[Oauth](Oauth.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)> @@ -269,11 +255,11 @@ Promise<[Oauth](Oauth.mdx)> ___ -### generateToken +#### generateToken `**generateToken**(appName, code, state): Promise<[Oauth](Oauth.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)> @@ -323,11 +309,11 @@ Promise<[Oauth](Oauth.mdx)> ___ -### list +#### list `**list**(selector): Promise<[Oauth](Oauth.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)[]> @@ -359,11 +345,11 @@ Promise<[Oauth](Oauth.mdx)[]> ___ -### refreshToken +#### refreshToken `**refreshToken**(appName): Promise<[Oauth](Oauth.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)> @@ -395,11 +381,11 @@ Promise<[Oauth](Oauth.mdx)> ___ -### registerOauthApp +#### registerOauthApp `**registerOauthApp**(appDetails): Promise<[Oauth](Oauth.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)> @@ -431,11 +417,11 @@ Promise<[Oauth](Oauth.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(oauthId): Promise<[Oauth](Oauth.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)> @@ -467,11 +453,11 @@ Promise<[Oauth](Oauth.mdx)> ___ -### retrieveByName +#### retrieveByName `**retrieveByName**(appName): Promise<[Oauth](Oauth.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)> @@ -503,11 +489,11 @@ Promise<[Oauth](Oauth.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -539,11 +525,11 @@ ___ ___ -### update +#### update `**update**(id, update): Promise<[Oauth](Oauth.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Oauth](Oauth.mdx)> @@ -584,11 +570,11 @@ Promise<[Oauth](Oauth.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [OauthService](OauthService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [OauthService](OauthService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Order.mdx b/www/apps/docs/content/references/services/classes/Order.mdx index a56b6adc27..b66b781fd9 100644 --- a/www/apps/docs/content/references/services/classes/Order.mdx +++ b/www/apps/docs/content/references/services/classes/Order.mdx @@ -10,7 +10,7 @@ An order is a purchase made by a customer. It holds details about payment and fu ## Constructors -### constructor +#### constructor `**new Order**()` @@ -536,11 +536,11 @@ An order is a purchase made by a customer. It holds details about payment and fu ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): Promise<void>` -#### Returns +##### Returns Promise<void> diff --git a/www/apps/docs/content/references/services/classes/OrderEdit.mdx b/www/apps/docs/content/references/services/classes/OrderEdit.mdx index 3e2ea7b6a9..ba22c065fe 100644 --- a/www/apps/docs/content/references/services/classes/OrderEdit.mdx +++ b/www/apps/docs/content/references/services/classes/OrderEdit.mdx @@ -10,7 +10,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele ## Constructors -### constructor +#### constructor `**new OrderEdit**()` @@ -284,11 +284,11 @@ Order edit allows modifying items in an order, such as adding, updating, or dele ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` @@ -306,11 +306,11 @@ Order edit allows modifying items in an order, such as adding, updating, or dele ___ -### loadStatus +#### loadStatus `**loadStatus**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx b/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx index 3a960290e2..ea90a7450a 100644 --- a/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx +++ b/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new OrderEditItemChangeService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -171,6 +155,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -242,11 +228,11 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[OrderItemChange](OrderItemChange.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderItemChange](OrderItemChange.mdx)> @@ -278,11 +264,11 @@ Promise<[OrderItemChange](OrderItemChange.mdx)> ___ -### delete +#### delete `**delete**(itemChangeIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -314,11 +300,11 @@ Promise<void> ___ -### list +#### list `**list**(selector, config?): Promise<[OrderItemChange](OrderItemChange.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderItemChange](OrderItemChange.mdx)[]> @@ -359,11 +345,11 @@ Promise<[OrderItemChange](OrderItemChange.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(id, config?): Promise<[OrderItemChange](OrderItemChange.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderItemChange](OrderItemChange.mdx)> @@ -404,11 +390,11 @@ Promise<[OrderItemChange](OrderItemChange.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -440,11 +426,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [OrderEditItemChangeService](OrderEditItemChangeService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [OrderEditItemChangeService](OrderEditItemChangeService.mdx) diff --git a/www/apps/docs/content/references/services/classes/OrderEditService.mdx b/www/apps/docs/content/references/services/classes/OrderEditService.mdx index 09b553b4cc..dc08c1612a 100644 --- a/www/apps/docs/content/references/services/classes/OrderEditService.mdx +++ b/www/apps/docs/content/references/services/classes/OrderEditService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new OrderEditService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ___ -### inventoryService\_ +#### inventoryService\_ -`Protected get**inventoryService_**(): undefined \| [IInventoryService](../interfaces/IInventoryService.mdx)` - -#### Returns - -`undefined` \| [IInventoryService](../interfaces/IInventoryService.mdx) - - + `Protected` **inventoryService\_**: [object Object] ## Methods -### addLineItem +#### addLineItem `**addLineItem**(orderEditId, data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -311,7 +279,7 @@ Promise<void> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -319,6 +287,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -390,11 +360,11 @@ Promise<TResult> ___ -### cancel +#### cancel `**cancel**(orderEditId, context?): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -444,11 +414,11 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### confirm +#### confirm `**confirm**(orderEditId, context?): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -498,11 +468,11 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### create +#### create `**create**(data, context): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -552,11 +522,11 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### decline +#### decline `**decline**(orderEditId, context): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -615,11 +585,11 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### decorateTotals +#### decorateTotals `**decorateTotals**(orderEdit): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -651,11 +621,11 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### delete +#### delete `**delete**(id): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -687,11 +657,11 @@ Promise<void> ___ -### deleteClonedItems +#### deleteClonedItems `Protected **deleteClonedItems**(orderEditId): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -723,11 +693,11 @@ Promise<void> ___ -### deleteItemChange +#### deleteItemChange `**deleteItemChange**(orderEditId, itemChangeId): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -768,11 +738,11 @@ Promise<void> ___ -### list +#### list `**list**(selector, config?): Promise<[OrderEdit](OrderEdit.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)[]> @@ -813,11 +783,11 @@ Promise<[OrderEdit](OrderEdit.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[OrderEdit](OrderEdit.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[OrderEdit](OrderEdit.mdx)[], number]> @@ -858,11 +828,11 @@ Promise<[[OrderEdit](OrderEdit.mdx)[], number]> ___ -### refreshAdjustments +#### refreshAdjustments `**refreshAdjustments**(orderEditId, config?): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -912,11 +882,11 @@ Promise<void> ___ -### removeLineItem +#### removeLineItem `**removeLineItem**(orderEditId, lineItemId): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -957,11 +927,11 @@ Promise<void> ___ -### requestConfirmation +#### requestConfirmation `**requestConfirmation**(orderEditId, context?): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -1011,11 +981,11 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(orderEditId, config?): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -1056,11 +1026,11 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### retrieveActive +#### retrieveActive `Protected **retrieveActive**(orderId, config?): Promise<undefined \| null \| [OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| null \| [OrderEdit](OrderEdit.mdx)> @@ -1101,11 +1071,11 @@ Promise<undefined \| null \| [OrderEdit](OrderEdit.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1137,11 +1107,11 @@ ___ ___ -### update +#### update `**update**(orderEditId, data): Promise<[OrderEdit](OrderEdit.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[OrderEdit](OrderEdit.mdx)> @@ -1182,7 +1152,7 @@ Promise<[OrderEdit](OrderEdit.mdx)> ___ -### updateLineItem +#### updateLineItem `**updateLineItem**(orderEditId, itemId, data): Promise<void>` @@ -1190,7 +1160,7 @@ Create or update order edit item change line item and apply the quantity - If the item change already exists then update the quantity of the line item as well as the line adjustments - If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1249,11 +1219,11 @@ Promise<void> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [OrderEditService](OrderEditService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [OrderEditService](OrderEditService.mdx) @@ -1285,11 +1255,11 @@ ___ ___ -### isOrderEditActive +#### isOrderEditActive `Static Private **isOrderEditActive**(orderEdit): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` diff --git a/www/apps/docs/content/references/services/classes/OrderItemChange.mdx b/www/apps/docs/content/references/services/classes/OrderItemChange.mdx index bd076b2a1f..7c7c6ba75e 100644 --- a/www/apps/docs/content/references/services/classes/OrderItemChange.mdx +++ b/www/apps/docs/content/references/services/classes/OrderItemChange.mdx @@ -10,7 +10,7 @@ An order item change is a change made within an order edit to an order's items. ## Constructors -### constructor +#### constructor `**new OrderItemChange**()` @@ -122,11 +122,11 @@ An order item change is a change made within an order edit to an order's items. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/OrderService.mdx b/www/apps/docs/content/references/services/classes/OrderService.mdx index cefa20c637..5e2de31ef7 100644 --- a/www/apps/docs/content/references/services/classes/OrderService.mdx +++ b/www/apps/docs/content/references/services/classes/OrderService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new OrderService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addShippingMethod +#### addShippingMethod `**addShippingMethod**(orderId, optionId, data?, config?): Promise<[Order](Order.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -505,14 +489,14 @@ Promise<[Order](Order.mdx)> ___ -### archive +#### archive `**archive**(orderId): Promise<[Order](Order.mdx)>` Archives an order. It only alloved, if the order has been fulfilled and payment has been captured. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -544,7 +528,7 @@ Promise<[Order](Order.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -552,6 +536,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -623,7 +609,7 @@ Promise<TResult> ___ -### cancel +#### cancel `**cancel**(orderId): Promise<[Order](Order.mdx)>` @@ -631,7 +617,7 @@ Cancels an order. Throws if fulfillment process has been initiated. Throws if payment process has been initiated. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -663,13 +649,13 @@ Promise<[Order](Order.mdx)> ___ -### cancelFulfillment +#### cancelFulfillment `**cancelFulfillment**(fulfillmentId): Promise<[Order](Order.mdx)>` Cancels a fulfillment (if related to an order) -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -701,13 +687,13 @@ Promise<[Order](Order.mdx)> ___ -### capturePayment +#### capturePayment `**capturePayment**(orderId): Promise<[Order](Order.mdx)>` Captures payment for an order. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -739,11 +725,11 @@ Promise<[Order](Order.mdx)> ___ -### completeOrder +#### completeOrder `**completeOrder**(orderId): Promise<[Order](Order.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -775,13 +761,13 @@ Promise<[Order](Order.mdx)> ___ -### createFromCart +#### createFromCart `**createFromCart**(cartOrId): Promise<[Order](Order.mdx)>` Creates an order from a cart -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -813,7 +799,7 @@ Promise<[Order](Order.mdx)> ___ -### createFulfillment +#### createFulfillment `**createFulfillment**(orderId, itemsToFulfill, config?): Promise<[Order](Order.mdx)>` @@ -822,7 +808,7 @@ In a situation where the order has more than one shipping method, we need to partition the order items, such that they can be sent to their respective fulfillment provider. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -899,11 +885,11 @@ Promise<[Order](Order.mdx)> ___ -### createGiftCardsFromLineItem\_ +#### createGiftCardsFromLineItem\_ `Protected **createGiftCardsFromLineItem_**(order, lineItem, manager): Promise<[GiftCard](GiftCard.mdx)>[]` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[GiftCard](GiftCard.mdx)>[] @@ -953,13 +939,13 @@ Promise<[GiftCard](GiftCard.mdx)>[] ___ -### createRefund +#### createRefund `**createRefund**(orderId, refundAmount, reason, note?, config?): Promise<[Order](Order.mdx)>` Refunds a given amount back to the customer. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1036,7 +1022,7 @@ Promise<[Order](Order.mdx)> ___ -### createShipment +#### createShipment `**createShipment**(orderId, fulfillmentId, trackingLinks?, config?): Promise<[Order](Order.mdx)>` @@ -1044,7 +1030,7 @@ Adds a shipment to the order to indicate that an order has left the warehouse. Will ask the fulfillment provider for any documents that may have been created in regards to the shipment. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1121,13 +1107,13 @@ Promise<[Order](Order.mdx)> ___ -### decorateTotals +#### decorateTotals `**decorateTotals**(order, totalsFields?): Promise<[Order](Order.mdx)>` Calculate and attach the different total fields on the object -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1170,7 +1156,7 @@ Promise<[Order](Order.mdx)> Calculate and attach the different total fields on the object -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1211,11 +1197,11 @@ Promise<[Order](Order.mdx)> ___ -### decorateTotalsLegacy +#### decorateTotalsLegacy `Protected **decorateTotalsLegacy**(order, totalsFields?): Promise<[Order](Order.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1256,13 +1242,13 @@ Promise<[Order](Order.mdx)> ___ -### getFulfillmentItems +#### getFulfillmentItems `Protected **getFulfillmentItems**(order, items, transformer): Promise<[LineItem](LineItem.mdx)[]>` Retrieves the order line items, given an array of items. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx)[]> @@ -1312,11 +1298,11 @@ Promise<[LineItem](LineItem.mdx)[]> ___ -### getTotalsRelations +#### getTotalsRelations `Private **getTotalsRelations**(config): string[]` -#### Parameters +##### Parameters -#### Returns +##### Returns `string`[] @@ -1348,11 +1334,11 @@ ___ ___ -### list +#### list `**list**(selector, config?): Promise<[Order](Order.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)[]> @@ -1393,11 +1379,11 @@ Promise<[Order](Order.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Order](Order.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Order](Order.mdx)[], number]> @@ -1438,7 +1424,7 @@ Promise<[[Order](Order.mdx)[], number]> ___ -### registerReturnReceived +#### registerReturnReceived `**registerReturnReceived**(orderId, receivedReturn, customRefundAmount?): Promise<[Order](Order.mdx)>` @@ -1450,7 +1436,7 @@ returned items are not matching the requested items. Setting the allowMismatch argument to true, will process the return, ignoring any mismatches. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1500,13 +1486,13 @@ Promise<[Order](Order.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(orderId, config?): Promise<[Order](Order.mdx)>` Gets an order by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1547,13 +1533,13 @@ Promise<[Order](Order.mdx)> ___ -### retrieveByCartId +#### retrieveByCartId `**retrieveByCartId**(cartId, config?): Promise<[Order](Order.mdx)>` Gets an order by cart id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1594,11 +1580,11 @@ Promise<[Order](Order.mdx)> ___ -### retrieveByCartIdWithTotals +#### retrieveByCartIdWithTotals `**retrieveByCartIdWithTotals**(cartId, options?): Promise<[Order](Order.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1639,13 +1625,13 @@ Promise<[Order](Order.mdx)> ___ -### retrieveByExternalId +#### retrieveByExternalId `**retrieveByExternalId**(externalId, config?): Promise<[Order](Order.mdx)>` Gets an order by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1686,11 +1672,11 @@ Promise<[Order](Order.mdx)> ___ -### retrieveLegacy +#### retrieveLegacy `Protected **retrieveLegacy**(orderIdOrSelector, config?): Promise<[Order](Order.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1731,11 +1717,11 @@ Promise<[Order](Order.mdx)> ___ -### retrieveWithTotals +#### retrieveWithTotals `**retrieveWithTotals**(orderId, options?, context?): Promise<[Order](Order.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1785,11 +1771,11 @@ Promise<[Order](Order.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1821,11 +1807,11 @@ ___ ___ -### transformQueryForTotals +#### transformQueryForTotals `Protected **transformQueryForTotals**(config): { relations: undefined \| string[] ; select: undefined \| keyof [Order](Order.mdx)[] ; totalsToSelect: undefined \| keyof [Order](Order.mdx)[] }` -#### Parameters +##### Parameters -#### Returns +##### Returns `object` @@ -1887,7 +1873,7 @@ ___ ___ -### update +#### update `**update**(orderId, update): Promise<[Order](Order.mdx)>` @@ -1895,7 +1881,7 @@ Updates an order. Metadata updates should use dedicated method, e.g. `setMetadata` etc. The function will throw errors if metadata updates are attempted. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Order](Order.mdx)> @@ -1936,13 +1922,13 @@ Promise<[Order](Order.mdx)> ___ -### updateBillingAddress +#### updateBillingAddress `Protected **updateBillingAddress**(order, address): Promise<void>` Updates the order's billing address. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1983,13 +1969,13 @@ Promise<void> ___ -### updateShippingAddress +#### updateShippingAddress `Protected **updateShippingAddress**(order, address): Promise<void>` Updates the order's shipping address. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -2030,7 +2016,7 @@ Promise<void> ___ -### validateFulfillmentLineItem +#### validateFulfillmentLineItem `Protected **validateFulfillmentLineItem**(item, quantity): null \| [LineItem](LineItem.mdx)` @@ -2039,7 +2025,7 @@ fulfillable quantity is lower than the requested fulfillment quantity. Fulfillable quantity is calculated by subtracting the already fulfilled quantity from the quantity that was originally purchased. -#### Parameters +##### Parameters -#### Returns +##### Returns `null` \| [LineItem](LineItem.mdx) @@ -2080,11 +2066,11 @@ quantity from the quantity that was originally purchased. ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [OrderService](OrderService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [OrderService](OrderService.mdx) diff --git a/www/apps/docs/content/references/services/classes/OrdersReturnItem.mdx b/www/apps/docs/content/references/services/classes/OrdersReturnItem.mdx index 886870620a..d1ae536c4f 100644 --- a/www/apps/docs/content/references/services/classes/OrdersReturnItem.mdx +++ b/www/apps/docs/content/references/services/classes/OrdersReturnItem.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new OrdersReturnItem**()` diff --git a/www/apps/docs/content/references/services/classes/Payment.mdx b/www/apps/docs/content/references/services/classes/Payment.mdx index fc958d3cd2..579779874e 100644 --- a/www/apps/docs/content/references/services/classes/Payment.mdx +++ b/www/apps/docs/content/references/services/classes/Payment.mdx @@ -10,7 +10,7 @@ A payment is originally created from a payment session. Once a payment session i ## Constructors -### constructor +#### constructor `**new Payment**()` @@ -194,11 +194,11 @@ A payment is originally created from a payment session. Once a payment session i ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/PaymentCollection.mdx b/www/apps/docs/content/references/services/classes/PaymentCollection.mdx index d5a029ee84..d00b3393a8 100644 --- a/www/apps/docs/content/references/services/classes/PaymentCollection.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentCollection.mdx @@ -10,7 +10,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi ## Constructors -### constructor +#### constructor `**new PaymentCollection**()` @@ -176,11 +176,11 @@ A payment collection allows grouping and managing a list of payments at one. Thi ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/PaymentCollectionService.mdx b/www/apps/docs/content/references/services/classes/PaymentCollectionService.mdx index 3d3753750a..fa488ded00 100644 --- a/www/apps/docs/content/references/services/classes/PaymentCollectionService.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentCollectionService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new PaymentCollectionService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -189,6 +173,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -260,13 +246,13 @@ Promise<TResult> ___ -### authorizePaymentSessions +#### authorizePaymentSessions `**authorizePaymentSessions**(paymentCollectionId, sessionIds, context?): Promise<[PaymentCollection](PaymentCollection.mdx)>` Authorizes the payment sessions of a payment collection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentCollection](PaymentCollection.mdx)> @@ -316,13 +302,13 @@ Promise<[PaymentCollection](PaymentCollection.mdx)> ___ -### create +#### create `**create**(data): Promise<[PaymentCollection](PaymentCollection.mdx)>` Creates a new payment collection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentCollection](PaymentCollection.mdx)> @@ -354,13 +340,13 @@ Promise<[PaymentCollection](PaymentCollection.mdx)> ___ -### delete +#### delete `**delete**(paymentCollectionId): Promise<undefined \| [PaymentCollection](PaymentCollection.mdx)>` Deletes a payment collection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| [PaymentCollection](PaymentCollection.mdx)> @@ -392,11 +378,11 @@ Promise<undefined \| [PaymentCollection](PaymentCollection.mdx)> ___ -### isValidTotalAmount +#### isValidTotalAmount `Private **isValidTotalAmount**(total, sessionsInput): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -437,13 +423,13 @@ ___ ___ -### markAsAuthorized +#### markAsAuthorized `**markAsAuthorized**(paymentCollectionId): Promise<[PaymentCollection](PaymentCollection.mdx)>` Marks a payment collection as authorized bypassing the payment flow. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentCollection](PaymentCollection.mdx)> @@ -475,13 +461,13 @@ Promise<[PaymentCollection](PaymentCollection.mdx)> ___ -### refreshPaymentSession +#### refreshPaymentSession `**refreshPaymentSession**(paymentCollectionId, sessionId, customerId): Promise<[PaymentSession](PaymentSession.mdx)>` Removes and recreate a payment session of a payment collection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -531,13 +517,13 @@ Promise<[PaymentSession](PaymentSession.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(paymentCollectionId, config?): Promise<[PaymentCollection](PaymentCollection.mdx)>` Retrieves a payment collection by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentCollection](PaymentCollection.mdx)> @@ -578,13 +564,13 @@ Promise<[PaymentCollection](PaymentCollection.mdx)> ___ -### setPaymentSession +#### setPaymentSession `**setPaymentSession**(paymentCollectionId, sessionInput, customerId): Promise<[PaymentCollection](PaymentCollection.mdx)>` Manages a single payment sessions of a payment collection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentCollection](PaymentCollection.mdx)> @@ -634,13 +620,13 @@ Promise<[PaymentCollection](PaymentCollection.mdx)> ___ -### setPaymentSessionsBatch +#### setPaymentSessionsBatch `**setPaymentSessionsBatch**(paymentCollectionOrId, sessionsInput, customerId): Promise<[PaymentCollection](PaymentCollection.mdx)>` Manages multiple payment sessions of a payment collection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentCollection](PaymentCollection.mdx)> @@ -690,11 +676,11 @@ Promise<[PaymentCollection](PaymentCollection.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -726,13 +712,13 @@ ___ ___ -### update +#### update `**update**(paymentCollectionId, data): Promise<[PaymentCollection](PaymentCollection.mdx)>` Updates a payment collection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentCollection](PaymentCollection.mdx)> @@ -773,11 +759,11 @@ Promise<[PaymentCollection](PaymentCollection.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [PaymentCollectionService](PaymentCollectionService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [PaymentCollectionService](PaymentCollectionService.mdx) diff --git a/www/apps/docs/content/references/services/classes/PaymentProvider.mdx b/www/apps/docs/content/references/services/classes/PaymentProvider.mdx index 7c187bb7e7..93d7cb5260 100644 --- a/www/apps/docs/content/references/services/classes/PaymentProvider.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentProvider.mdx @@ -10,7 +10,7 @@ A payment provider represents a payment service installed in the Medusa backend, ## Constructors -### constructor +#### constructor `**new PaymentProvider**()` diff --git a/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx b/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx index 03e4470812..3aece1014f 100644 --- a/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx @@ -10,11 +10,11 @@ Helps retrieve payment providers ## Constructors -### constructor +#### constructor `**new PaymentProviderService**(container)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ___ -### paymentService\_ +#### paymentService\_ -`Protected get**paymentService_**(): [PaymentService](PaymentService.mdx)` - -#### Returns - -[PaymentService](PaymentService.mdx) - - + `Protected` **paymentService\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -204,6 +172,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -275,11 +245,11 @@ Promise<TResult> ___ -### authorizePayment +#### authorizePayment `**authorizePayment**(paymentSession, context): Promise<undefined \| [PaymentSession](PaymentSession.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| [PaymentSession](PaymentSession.mdx)> @@ -320,13 +290,13 @@ Promise<undefined \| [PaymentSession](PaymentSession.mdx)> ___ -### buildPaymentProcessorContext +#### buildPaymentProcessorContext `Protected **buildPaymentProcessorContext**(cartOrData): [Cart](Cart.mdx) & [PaymentContext](../types/PaymentContext.mdx)` Build the create session context for both legacy and new API -#### Parameters +##### Parameters -#### Returns +##### Returns [Cart](Cart.mdx) & [PaymentContext](../types/PaymentContext.mdx) @@ -358,11 +328,11 @@ Build the create session context for both legacy and new API ___ -### cancelPayment +#### cancelPayment `**cancelPayment**(paymentObj): Promise<[Payment](Payment.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -394,11 +364,11 @@ Promise<[Payment](Payment.mdx)> ___ -### capturePayment +#### capturePayment `**capturePayment**(paymentObj): Promise<[Payment](Payment.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -430,11 +400,11 @@ Promise<[Payment](Payment.mdx)> ___ -### createPayment +#### createPayment `**createPayment**(data): Promise<[Payment](Payment.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -466,11 +436,11 @@ Promise<[Payment](Payment.mdx)> ___ -### createSession +#### createSession `**createSession**(providerId, cart): Promise<[PaymentSession](PaymentSession.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -515,7 +485,7 @@ Promise<[PaymentSession](PaymentSession.mdx)> Creates a payment session with the given provider. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -547,11 +517,11 @@ Promise<[PaymentSession](PaymentSession.mdx)> ___ -### deleteSession +#### deleteSession `**deleteSession**(paymentSession): Promise<undefined \| [PaymentSession](PaymentSession.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| [PaymentSession](PaymentSession.mdx)> @@ -583,11 +553,11 @@ Promise<undefined \| [PaymentSession](PaymentSession.mdx)> ___ -### getStatus +#### getStatus `**getStatus**(payment): Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)> @@ -619,11 +589,11 @@ Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)> ___ -### list +#### list `**list**(): Promise<[PaymentProvider](PaymentProvider.mdx)[]>` -#### Returns +##### Returns Promise<[PaymentProvider](PaymentProvider.mdx)[]> @@ -641,13 +611,13 @@ Promise<[PaymentProvider](PaymentProvider.mdx)[]> ___ -### listPayments +#### listPayments `**listPayments**(selector, config?): Promise<[Payment](Payment.mdx)[]>` List all the payments according to the given selector and config. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)[]> @@ -688,13 +658,13 @@ Promise<[Payment](Payment.mdx)[]> ___ -### processUpdateRequestsData +#### processUpdateRequestsData `Protected **processUpdateRequestsData**(data?, paymentResponse): Promise<void>` Process the collected data. Can be used every time we need to process some collected data returned by the provider -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -753,14 +723,14 @@ Promise<void> ___ -### refreshSession +#### refreshSession `**refreshSession**(paymentSession, sessionInput): Promise<[PaymentSession](PaymentSession.mdx)>` Refreshes a payment session with the given provider. This means, that we delete the current one and create a new. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -828,11 +798,11 @@ Promise<[PaymentSession](PaymentSession.mdx)> ___ -### refundFromPayment +#### refundFromPayment `**refundFromPayment**(payment, amount, reason, note?): Promise<[Refund](Refund.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Refund](Refund.mdx)> @@ -891,11 +861,11 @@ Promise<[Refund](Refund.mdx)> ___ -### refundPayment +#### refundPayment `**refundPayment**(payObjs, amount, reason, note?): Promise<[Refund](Refund.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Refund](Refund.mdx)> @@ -954,11 +924,11 @@ Promise<[Refund](Refund.mdx)> ___ -### registerInstalledProviders +#### registerInstalledProviders `**registerInstalledProviders**(providerIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -990,13 +960,13 @@ Promise<void> ___ -### retrievePayment +#### retrievePayment `**retrievePayment**(paymentId, relations?): Promise<[Payment](Payment.mdx)>` Retrieve a payment entity with the given id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -1037,12 +1007,14 @@ Promise<[Payment](Payment.mdx)> ___ -### retrieveProvider +#### retrieveProvider `**retrieveProvider**(providerId): TProvider extends [AbstractPaymentService](AbstractPaymentService.mdx) ? [AbstractPaymentService](AbstractPaymentService.mdx) : TProvider extends [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) ? [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) : any` Finds a provider given an id +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `TProvider` extends [AbstractPaymentService](AbstractPaymentService.mdx) ? [AbstractPaymentService](AbstractPaymentService.mdx) : `TProvider` extends [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) ? [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) : `any` @@ -1087,11 +1059,11 @@ Finds a provider given an id ___ -### retrieveRefund +#### retrieveRefund `**retrieveRefund**(id, config?): Promise<[Refund](Refund.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Refund](Refund.mdx)> @@ -1132,13 +1104,13 @@ Promise<[Refund](Refund.mdx)> ___ -### retrieveSession +#### retrieveSession `**retrieveSession**(paymentSessionId, relations?): Promise<[PaymentSession](PaymentSession.mdx)>` Return the payment session for the given id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -1179,13 +1151,13 @@ Promise<[PaymentSession](PaymentSession.mdx)> ___ -### saveSession +#### saveSession `Protected **saveSession**(providerId, data): Promise<[PaymentSession](PaymentSession.mdx)>` Create or update a Payment session data. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -1289,11 +1261,11 @@ Promise<[PaymentSession](PaymentSession.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1325,11 +1297,11 @@ ___ ___ -### throwFromPaymentProcessorError +#### throwFromPaymentProcessorError `Private **throwFromPaymentProcessorError**(errObj): void` -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -1361,11 +1333,11 @@ ___ ___ -### updatePayment +#### updatePayment `**updatePayment**(paymentId, data): Promise<[Payment](Payment.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -1424,13 +1396,13 @@ Promise<[Payment](Payment.mdx)> ___ -### updateSession +#### updateSession `**updateSession**(paymentSession, sessionInput): Promise<[PaymentSession](PaymentSession.mdx)>` Update a payment session with the given provider. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -1498,11 +1470,11 @@ Promise<[PaymentSession](PaymentSession.mdx)> ___ -### updateSessionData +#### updateSessionData `**updateSessionData**(paymentSession, data): Promise<[PaymentSession](PaymentSession.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSession](PaymentSession.mdx)> @@ -1543,11 +1515,11 @@ Promise<[PaymentSession](PaymentSession.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [PaymentProviderService](PaymentProviderService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [PaymentProviderService](PaymentProviderService.mdx) diff --git a/www/apps/docs/content/references/services/classes/PaymentService.mdx b/www/apps/docs/content/references/services/classes/PaymentService.mdx index a8e6102108..ac924f8c9d 100644 --- a/www/apps/docs/content/references/services/classes/PaymentService.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new PaymentService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -198,6 +182,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -269,13 +255,13 @@ Promise<TResult> ___ -### capture +#### capture `**capture**(paymentOrId): Promise<[Payment](Payment.mdx)>` Captures a payment. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -307,13 +293,13 @@ Promise<[Payment](Payment.mdx)> ___ -### create +#### create `**create**(paymentInput): Promise<[Payment](Payment.mdx)>` Created a new payment. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -345,13 +331,13 @@ Promise<[Payment](Payment.mdx)> ___ -### refund +#### refund `**refund**(paymentOrId, amount, reason, note?): Promise<[Refund](Refund.mdx)>` refunds a payment. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Refund](Refund.mdx)> @@ -410,13 +396,13 @@ Promise<[Refund](Refund.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(paymentId, config?): Promise<[Payment](Payment.mdx)>` Retrieves a payment by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -457,11 +443,11 @@ Promise<[Payment](Payment.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -493,13 +479,13 @@ ___ ___ -### update +#### update `**update**(paymentId, data): Promise<[Payment](Payment.mdx)>` Updates a payment in order to link it to an order or a swap. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Payment](Payment.mdx)> @@ -558,11 +544,11 @@ Promise<[Payment](Payment.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [PaymentService](PaymentService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [PaymentService](PaymentService.mdx) diff --git a/www/apps/docs/content/references/services/classes/PaymentSession.mdx b/www/apps/docs/content/references/services/classes/PaymentSession.mdx index 41b41b653f..84cad8bebc 100644 --- a/www/apps/docs/content/references/services/classes/PaymentSession.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentSession.mdx @@ -10,7 +10,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c ## Constructors -### constructor +#### constructor `**new PaymentSession**()` @@ -140,11 +140,11 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/PriceList.mdx b/www/apps/docs/content/references/services/classes/PriceList.mdx index 2f15d6b95d..6215b35f4e 100644 --- a/www/apps/docs/content/references/services/classes/PriceList.mdx +++ b/www/apps/docs/content/references/services/classes/PriceList.mdx @@ -10,7 +10,7 @@ A Price List represents a set of prices that override the default price for one ## Constructors -### constructor +#### constructor `**new PriceList**()` @@ -141,11 +141,11 @@ A Price List represents a set of prices that override the default price for one ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): undefined \| void` -#### Returns +##### Returns `undefined` \| `void` diff --git a/www/apps/docs/content/references/services/classes/PriceListService.mdx b/www/apps/docs/content/references/services/classes/PriceListService.mdx index c52bba0fd0..5602d22640 100644 --- a/www/apps/docs/content/references/services/classes/PriceListService.mdx +++ b/www/apps/docs/content/references/services/classes/PriceListService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate product tags. ## Constructors -### constructor +#### constructor `**new PriceListService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addCurrencyFromRegion +#### addCurrencyFromRegion `Protected **addCurrencyFromRegion**(prices): Promise<T[]>` Add `currency_code` to an MA record if `region_id`is passed. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<T[]> @@ -224,13 +210,13 @@ Promise<T[]> ___ -### addPrices +#### addPrices `**addPrices**(id, prices, replace?): Promise<[PriceList](PriceList.mdx)>` Adds prices to a price list in bulk, optionally replacing all existing prices -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceList](PriceList.mdx)> @@ -280,7 +266,7 @@ Promise<[PriceList](PriceList.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -288,6 +274,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -359,13 +347,13 @@ Promise<TResult> ___ -### clearPrices +#### clearPrices `**clearPrices**(id): Promise<void>` Removes all prices from a price list and deletes the removed prices in bulk -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -397,13 +385,13 @@ Promise<void> ___ -### create +#### create `**create**(priceListObject): Promise<[PriceList](PriceList.mdx)>` Creates a Price List -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceList](PriceList.mdx)> @@ -435,14 +423,14 @@ Promise<[PriceList](PriceList.mdx)> ___ -### delete +#### delete `**delete**(id): Promise<void>` Deletes a Price List Will never fail due to delete being idempotent. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -474,13 +462,13 @@ Promise<void> ___ -### deletePrices +#### deletePrices `**deletePrices**(id, priceIds): Promise<void>` Removes prices from a price list and deletes the removed prices in bulk -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -521,11 +509,11 @@ Promise<void> ___ -### deleteProductPrices +#### deleteProductPrices `**deleteProductPrices**(priceListId, productIds): Promise<[string[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[string[], number]> @@ -566,11 +554,11 @@ Promise<[string[], number]> ___ -### deleteVariantPrices +#### deleteVariantPrices `**deleteVariantPrices**(priceListId, variantIds): Promise<[string[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[string[], number]> @@ -611,13 +599,13 @@ Promise<[string[], number]> ___ -### list +#### list `**list**(selector?, config?): Promise<[PriceList](PriceList.mdx)[]>` Lists Price Lists -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceList](PriceList.mdx)[]> @@ -658,13 +646,13 @@ Promise<[PriceList](PriceList.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config?): Promise<[[PriceList](PriceList.mdx)[], number]>` Lists Price Lists and adds count -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[PriceList](PriceList.mdx)[], number]> @@ -705,11 +693,11 @@ Promise<[[PriceList](PriceList.mdx)[], number]> ___ -### listPriceListsVariantIdsMap +#### listPriceListsVariantIdsMap `**listPriceListsVariantIdsMap**(priceListIds): Promise<{ [priceListId: string]: string[]; }>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ [priceListId: string]: string[]; }> @@ -741,11 +729,11 @@ Promise<{ [priceListId: string]: string[]; }> ___ -### listProducts +#### listProducts `**listProducts**(priceListId, selector?, config?, requiresPriceList?): Promise<[[Product](Product.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Product](Product.mdx)[], number]> @@ -804,11 +792,11 @@ Promise<[[Product](Product.mdx)[], number]> ___ -### listVariants +#### listVariants `**listVariants**(priceListId, selector?, config?, requiresPriceList?): Promise<[[ProductVariant](ProductVariant.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[ProductVariant](ProductVariant.mdx)[], number]> @@ -867,13 +855,13 @@ Promise<[[ProductVariant](ProductVariant.mdx)[], number]> ___ -### retrieve +#### retrieve `**retrieve**(priceListId, config?): Promise<[PriceList](PriceList.mdx)>` Retrieves a product tag by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceList](PriceList.mdx)> @@ -914,11 +902,11 @@ Promise<[PriceList](PriceList.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -950,13 +938,13 @@ ___ ___ -### update +#### update `**update**(id, update): Promise<[PriceList](PriceList.mdx)>` Updates a Price List -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceList](PriceList.mdx)> @@ -997,11 +985,11 @@ Promise<[PriceList](PriceList.mdx)> ___ -### upsertCustomerGroups\_ +#### upsertCustomerGroups\_ `Protected **upsertCustomerGroups_**(priceListId, customerGroups): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1042,11 +1030,11 @@ Promise<void> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [PriceListService](PriceListService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [PriceListService](PriceListService.mdx) diff --git a/www/apps/docs/content/references/services/classes/PricingService.mdx b/www/apps/docs/content/references/services/classes/PricingService.mdx index 6bb3e40a8c..02892bf8f9 100644 --- a/www/apps/docs/content/references/services/classes/PricingService.mdx +++ b/www/apps/docs/content/references/services/classes/PricingService.mdx @@ -10,11 +10,11 @@ Allows retrieval of prices. ## Constructors -### constructor +#### constructor `**new PricingService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ___ -### pricingModuleService +#### pricingModuleService -`Protected get**pricingModuleService**(): [IPricingModuleService](../interfaces/IPricingModuleService.mdx)` - -#### Returns - -[IPricingModuleService](../interfaces/IPricingModuleService.mdx) - - Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "addPrices", - "type": "(`data`: [AddPricesDTO](../interfaces/AddPricesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>(`data`: [AddPricesDTO](../interfaces/AddPricesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "addRules", - "type": "(`data`: [AddRulesDTO](../interfaces/AddRulesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>(`data`: [AddRulesDTO](../interfaces/AddRulesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "calculatePrices", - "type": "(`filters`: [PricingFilters](../interfaces/PricingFilters.mdx), `context?`: [PricingContext](../interfaces/PricingContext.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[CalculatedPriceSetDTO](../interfaces/CalculatedPriceSetDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "create", - "type": "(`data`: [CreatePriceSetDTO](../interfaces/CreatePriceSetDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>(`data`: [CreatePriceSetDTO](../interfaces/CreatePriceSetDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createCurrencies", - "type": "(`data`: [CreateCurrencyDTO](../interfaces/CreateCurrencyDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createMoneyAmounts", - "type": "(`data`: [CreateMoneyAmountDTO](../interfaces/CreateMoneyAmountDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceListRules", - "type": "(`data`: [CreatePriceListRuleDTO](../interfaces/CreatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceLists", - "type": "(`data`: [CreatePriceListDTO](../interfaces/CreatePriceListDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceRules", - "type": "(`data`: [CreatePriceRuleDTO](../interfaces/CreatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createPriceSetMoneyAmountRules", - "type": "(`data`: [CreatePriceSetMoneyAmountRulesDTO](../interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createRuleTypes", - "type": "(`data`: [CreateRuleTypeDTO](../interfaces/CreateRuleTypeDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "delete", - "type": "(`ids`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteCurrencies", - "type": "(`currencyCodes`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteMoneyAmounts", - "type": "(`ids`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceListRules", - "type": "(`priceListRuleIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceLists", - "type": "(`priceListIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceRules", - "type": "(`priceRuleIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deletePriceSetMoneyAmountRules", - "type": "(`ids`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteRuleTypes", - "type": "(`ruleTypeIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "list", - "type": "(`filters?`: [FilterablePriceSetProps](../interfaces/FilterablePriceSetProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCount", - "type": "(`filters?`: [FilterablePriceSetProps](../interfaces/FilterablePriceSetProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceSetDTO](../interfaces/PriceSetDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountCurrencies", - "type": "(`filters?`: [FilterableCurrencyProps](../interfaces/FilterableCurrencyProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[CurrencyDTO](../interfaces/CurrencyDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountMoneyAmounts", - "type": "(`filters?`: [FilterableMoneyAmountProps](../interfaces/FilterableMoneyAmountProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceListRules", - "type": "(`filters?`: [FilterablePriceListRuleProps](../interfaces/FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceLists", - "type": "(`filters?`: [FilterablePriceListProps](../interfaces/FilterablePriceListProps-1.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListDTO](../interfaces/PriceListDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceListDTO](../interfaces/PriceListDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceRules", - "type": "(`filters?`: [FilterablePriceRuleProps](../interfaces/FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceSetMoneyAmountRules", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountRulesProps](../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountPriceSetMoneyAmounts", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountProps](../interfaces/FilterablePriceSetMoneyAmountProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetMoneyAmountDTO](../interfaces/PriceSetMoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceSetMoneyAmountDTO](../interfaces/PriceSetMoneyAmountDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCountRuleTypes", - "type": "(`filters?`: [FilterableRuleTypeProps](../interfaces/FilterableRuleTypeProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listCurrencies", - "type": "(`filters?`: [FilterableCurrencyProps](../interfaces/FilterableCurrencyProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listMoneyAmounts", - "type": "(`filters?`: [FilterableMoneyAmountProps](../interfaces/FilterableMoneyAmountProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceListRules", - "type": "(`filters?`: [FilterablePriceListRuleProps](../interfaces/FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceLists", - "type": "(`filters?`: [FilterablePriceListProps](../interfaces/FilterablePriceListProps-1.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListDTO](../interfaces/PriceListDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceRules", - "type": "(`filters?`: [FilterablePriceRuleProps](../interfaces/FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceSetMoneyAmountRules", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountRulesProps](../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listPriceSetMoneyAmounts", - "type": "(`filters?`: [FilterablePriceSetMoneyAmountProps](../interfaces/FilterablePriceSetMoneyAmountProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetMoneyAmountDTO](../interfaces/PriceSetMoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetMoneyAmountDTO](../interfaces/PriceSetMoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listRuleTypes", - "type": "(`filters?`: [FilterableRuleTypeProps](../interfaces/FilterableRuleTypeProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "removePriceListRules", - "type": "(`data`: [RemovePriceListRulesDTO](../interfaces/RemovePriceListRulesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "removeRules", - "type": "(`data`: [RemovePriceSetRulesDTO](../interfaces/RemovePriceSetRulesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveCurrency", - "type": "(`code`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveMoneyAmount", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceList", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListDTO](../interfaces/PriceListDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceListRule", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceRule", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrievePriceSetMoneyAmountRules", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveRuleType", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "setPriceListRules", - "type": "(`data`: [SetPriceListRulesDTO](../interfaces/SetPriceListRulesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateCurrencies", - "type": "(`data`: [UpdateCurrencyDTO](../interfaces/UpdateCurrencyDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateMoneyAmounts", - "type": "(`data`: [UpdateMoneyAmountDTO](../interfaces/UpdateMoneyAmountDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[MoneyAmountDTO](../interfaces/MoneyAmountDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceListRules", - "type": "(`data`: [UpdatePriceListRuleDTO](../interfaces/UpdatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceLists", - "type": "(`data`: [UpdatePriceListDTO](../interfaces/UpdatePriceListDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceRules", - "type": "(`data`: [UpdatePriceRuleDTO](../interfaces/UpdatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updatePriceSetMoneyAmountRules", - "type": "(`data`: [UpdatePriceSetMoneyAmountRulesDTO](../interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetMoneyAmountRulesDTO](../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateRuleTypes", - "type": "(`data`: [UpdateRuleTypeDTO](../interfaces/UpdateRuleTypeDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[RuleTypeDTO](../interfaces/RuleTypeDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> + `Protected` **pricingModuleService**: [object Object] ___ -### remoteQuery +#### remoteQuery -`Protected get**remoteQuery**(): [RemoteQueryFunction](../types/RemoteQueryFunction.mdx)` - -#### Returns - -[RemoteQueryFunction](../types/RemoteQueryFunction.mdx) - -`) => Promise<any> \\| `null`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> + `Protected` **remoteQuery**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -694,6 +160,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -765,13 +233,13 @@ Promise<TResult> ___ -### calculateTaxes +#### calculateTaxes `**calculateTaxes**(variantPricing, productRates): [TaxedPricing](../types/TaxedPricing.mdx)` Gets the prices for a product variant -#### Parameters +##### Parameters -#### Returns +##### Returns [TaxedPricing](../types/TaxedPricing.mdx) @@ -812,14 +280,14 @@ Gets the prices for a product variant ___ -### collectPricingContext +#### collectPricingContext `**collectPricingContext**(context): Promise<[PricingContext](../types/PricingContext-1.mdx)>` Collects additional information necessary for completing the price selection. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PricingContext](../types/PricingContext-1.mdx)> @@ -851,11 +319,11 @@ Promise<[PricingContext](../types/PricingContext-1.mdx)> ___ -### getPricingModuleVariantMoneyAmounts +#### getPricingModuleVariantMoneyAmounts `Private **getPricingModuleVariantMoneyAmounts**(variantIds): Promise<Map<string, [MoneyAmount](MoneyAmount.mdx)[]>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Map<string, [MoneyAmount](MoneyAmount.mdx)[]>> @@ -887,14 +355,14 @@ Promise<Map<string, [MoneyAmount](MoneyAmount.mdx)[]>> ___ -### getProductPricing +#### getProductPricing `**getProductPricing**(product, context): Promise<Record<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>>` Gets all the variant prices for a product. All the product's variants will be fetched. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>> @@ -935,13 +403,13 @@ Promise<Record<string, [ProductVariantPricing](../types/ProductVariantPr ___ -### getProductPricingById +#### getProductPricingById `**getProductPricingById**(productId, context): Promise<Record<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>>` Gets all the variant prices for a product by the product id -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>> @@ -982,11 +450,11 @@ Promise<Record<string, [ProductVariantPricing](../types/ProductVariantPr ___ -### getProductPricing\_ +#### getProductPricing\_ `Private **getProductPricing_**(data, context): Promise<Map<string, Record<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Map<string, Record<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>>> @@ -1027,13 +495,13 @@ Promise<Map<string, Record<string, [ProductVariantPricing](../types/ ___ -### getProductVariantPricing +#### getProductVariantPricing `**getProductVariantPricing**(variant, context): Promise<[ProductVariantPricing](../types/ProductVariantPricing.mdx)>` Gets the prices for a product variant. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariantPricing](../types/ProductVariantPricing.mdx)> @@ -1074,13 +542,13 @@ Promise<[ProductVariantPricing](../types/ProductVariantPricing.mdx)> ___ -### getProductVariantPricingById +#### getProductVariantPricingById `**getProductVariantPricingById**(variantId, context): Promise<[ProductVariantPricing](../types/ProductVariantPricing.mdx)>` Gets the prices for a product variant by a variant id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariantPricing](../types/ProductVariantPricing.mdx)> @@ -1125,11 +593,11 @@ Use [getProductVariantsPricing](PricingService.mdx#getproductvariantspricing) in ___ -### getProductVariantPricingModulePricing\_ +#### getProductVariantPricingModulePricing\_ `Private **getProductVariantPricingModulePricing_**(variantPriceData, context): Promise<Map<any, any>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Map<any, any>> @@ -1170,11 +638,11 @@ Promise<Map<any, any>> ___ -### getProductVariantPricing\_ +#### getProductVariantPricing\_ `Private **getProductVariantPricing_**(data, context): Promise<Map<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Map<string, [ProductVariantPricing](../types/ProductVariantPricing.mdx)>> @@ -1215,13 +683,13 @@ Promise<Map<string, [ProductVariantPricing](../types/ProductVariantPrici ___ -### getProductVariantsPricing +#### getProductVariantsPricing `**getProductVariantsPricing**(data, context): Promise<{ [variant_id: string]: [ProductVariantPricing](../types/ProductVariantPricing.mdx); }>` Gets the prices for a collection of variants. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ [variant_id: string]: [ProductVariantPricing](../types/ProductVariantPricing.mdx); }> @@ -1262,13 +730,13 @@ Promise<{ [variant_id: string]: [ProductVariantPricing](../types/Produc ___ -### getShippingOptionPricing +#### getShippingOptionPricing `**getShippingOptionPricing**(shippingOption, context): Promise<[PricedShippingOption](../types/PricedShippingOption.mdx)>` Gets the prices for a shipping option. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PricedShippingOption](../types/PricedShippingOption.mdx)> @@ -1309,11 +777,11 @@ Promise<[PricedShippingOption](../types/PricedShippingOption.mdx)> ___ -### setAdminProductPricing +#### setAdminProductPricing `**setAdminProductPricing**(products): Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.mdx))[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.mdx))[]> @@ -1345,11 +813,11 @@ Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.md ___ -### setAdminVariantPricing +#### setAdminVariantPricing `**setAdminVariantPricing**(variants, context?): Promise<[PricedVariant](../types/PricedVariant.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PricedVariant](../types/PricedVariant.mdx)[]> @@ -1390,13 +858,13 @@ Promise<[PricedVariant](../types/PricedVariant.mdx)[]> ___ -### setProductPrices +#### setProductPrices `**setProductPrices**(products, context?): Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.mdx))[]>` Set additional prices on a list of products. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.mdx))[]> @@ -1437,13 +905,13 @@ Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.md ___ -### setShippingOptionPrices +#### setShippingOptionPrices `**setShippingOptionPrices**(shippingOptions, context?): Promise<[PricedShippingOption](../types/PricedShippingOption.mdx)[]>` Set additional prices on a list of shipping options. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PricedShippingOption](../types/PricedShippingOption.mdx)[]> @@ -1484,13 +952,13 @@ Promise<[PricedShippingOption](../types/PricedShippingOption.mdx)[]> ___ -### setVariantPrices +#### setVariantPrices `**setVariantPrices**(variants, context?): Promise<[PricedVariant](../types/PricedVariant.mdx)[]>` Set additional prices on a list of product variants. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PricedVariant](../types/PricedVariant.mdx)[]> @@ -1531,11 +999,11 @@ Promise<[PricedVariant](../types/PricedVariant.mdx)[]> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1567,11 +1035,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [PricingService](PricingService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [PricingService](PricingService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Product.mdx b/www/apps/docs/content/references/services/classes/Product.mdx index 3f9d989247..c9e8bf6f34 100644 --- a/www/apps/docs/content/references/services/classes/Product.mdx +++ b/www/apps/docs/content/references/services/classes/Product.mdx @@ -10,7 +10,7 @@ A product is a saleable item that holds general information such as name or desc ## Constructors -### constructor +#### constructor `**new Product**()` @@ -339,11 +339,11 @@ A product is a saleable item that holds general information such as name or desc ## Methods -### afterLoad +#### afterLoad `Private **afterLoad**(): void` -#### Returns +##### Returns `void` @@ -361,11 +361,11 @@ A product is a saleable item that holds general information such as name or desc ___ -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` @@ -383,11 +383,11 @@ ___ ___ -### beforeUpdate +#### beforeUpdate `Private **beforeUpdate**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductCategory.mdx b/www/apps/docs/content/references/services/classes/ProductCategory.mdx index 392aa9119a..45428f7939 100644 --- a/www/apps/docs/content/references/services/classes/ProductCategory.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCategory.mdx @@ -10,7 +10,7 @@ A product category can be used to categorize products into a hierarchy of catego ## Constructors -### constructor +#### constructor `**new ProductCategory**()` @@ -167,11 +167,11 @@ A product category can be used to categorize products into a hierarchy of catego ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx b/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx index 3794171eba..3bf2eb6eab 100644 --- a/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate product categories. ## Constructors -### constructor +#### constructor `**new ProductCategoryService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addProducts +#### addProducts `**addProducts**(productCategoryId, productIds): Promise<void>` Add a batch of product to a product category -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -203,7 +187,7 @@ Promise<void> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -211,6 +195,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -282,13 +268,13 @@ Promise<TResult> ___ -### create +#### create `**create**(productCategoryInput): Promise<[ProductCategory](ProductCategory.mdx)>` Creates a product category -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCategory](ProductCategory.mdx)> @@ -320,13 +306,13 @@ Promise<[ProductCategory](ProductCategory.mdx)> ___ -### delete +#### delete `**delete**(productCategoryId): Promise<void>` Deletes a product category -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -358,11 +344,11 @@ Promise<void> ___ -### fetchReorderConditions +#### fetchReorderConditions `Protected **fetchReorderConditions**(productCategory, input, shouldDeleteElement?): [ReorderConditions](../types/ReorderConditions.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ReorderConditions](../types/ReorderConditions.mdx) @@ -412,14 +398,14 @@ ___ ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?, treeSelector?): Promise<[[ProductCategory](ProductCategory.mdx)[], number]>` Lists product category based on the provided parameters and includes the count of product category that match the query. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[ProductCategory](ProductCategory.mdx)[], number]> @@ -469,11 +455,11 @@ Promise<[[ProductCategory](ProductCategory.mdx)[], number]> ___ -### performReordering +#### performReordering `Protected **performReordering**(repository, conditions): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -514,13 +500,13 @@ Promise<void> ___ -### removeProducts +#### removeProducts `**removeProducts**(productCategoryId, productIds): Promise<void>` Remove a batch of product from a product category -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -561,13 +547,13 @@ Promise<void> ___ -### retrieve +#### retrieve `**retrieve**(productCategoryId, config?, selector?, treeSelector?): Promise<[ProductCategory](ProductCategory.mdx)>` Retrieves a product category by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCategory](ProductCategory.mdx)> @@ -626,13 +612,13 @@ Promise<[ProductCategory](ProductCategory.mdx)> ___ -### retrieveByHandle +#### retrieveByHandle `**retrieveByHandle**(handle, config?, selector?, treeSelector?): Promise<[ProductCategory](ProductCategory.mdx)>` Retrieves a product category by handle. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCategory](ProductCategory.mdx)> @@ -691,13 +677,13 @@ Promise<[ProductCategory](ProductCategory.mdx)> ___ -### retrieve\_ +#### retrieve\_ `Protected **retrieve_**(config?, selector?, treeSelector?): Promise<[ProductCategory](ProductCategory.mdx)>` A generic retrieve for fining product categories by different attributes. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCategory](ProductCategory.mdx)> @@ -747,11 +733,11 @@ Promise<[ProductCategory](ProductCategory.mdx)> ___ -### shiftSiblings +#### shiftSiblings `Protected **shiftSiblings**(repository, conditions): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -792,11 +778,11 @@ Promise<void> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -828,14 +814,14 @@ ___ ___ -### transformParentIdToEntity +#### transformParentIdToEntity `Protected **transformParentIdToEntity**(productCategoryInput): Promise<[CreateProductCategoryInput](../types/CreateProductCategoryInput.mdx) \| [UpdateProductCategoryInput](../types/UpdateProductCategoryInput.mdx)>` Accepts an input object and transforms product\_category\_id into product\_category entity. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CreateProductCategoryInput](../types/CreateProductCategoryInput.mdx) \| [UpdateProductCategoryInput](../types/UpdateProductCategoryInput.mdx)> @@ -867,13 +853,13 @@ Promise<[CreateProductCategoryInput](../types/CreateProductCategoryInput.mdx ___ -### update +#### update `**update**(productCategoryId, productCategoryInput): Promise<[ProductCategory](ProductCategory.mdx)>` Updates a product category -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCategory](ProductCategory.mdx)> @@ -914,11 +900,11 @@ Promise<[ProductCategory](ProductCategory.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ProductCategoryService](ProductCategoryService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ProductCategoryService](ProductCategoryService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ProductCollection.mdx b/www/apps/docs/content/references/services/classes/ProductCollection.mdx index 2cc5d884b5..16234f90ed 100644 --- a/www/apps/docs/content/references/services/classes/ProductCollection.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCollection.mdx @@ -10,7 +10,7 @@ A Product Collection allows grouping together products for promotional purposes. ## Constructors -### constructor +#### constructor `**new ProductCollection**()` @@ -95,11 +95,11 @@ A Product Collection allows grouping together products for promotional purposes. ## Methods -### createHandleIfNotProvided +#### createHandleIfNotProvided `Private **createHandleIfNotProvided**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx b/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx index 097f9ad3b3..79a75b4fd0 100644 --- a/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate product collections. ## Constructors -### constructor +#### constructor `**new ProductCollectionService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addProducts +#### addProducts `**addProducts**(collectionId, productIds): Promise<[ProductCollection](ProductCollection.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCollection](ProductCollection.mdx)> @@ -228,7 +212,7 @@ Promise<[ProductCollection](ProductCollection.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -236,6 +220,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -307,13 +293,13 @@ Promise<TResult> ___ -### create +#### create `**create**(collection): Promise<[ProductCollection](ProductCollection.mdx)>` Creates a product collection -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCollection](ProductCollection.mdx)> @@ -345,13 +331,13 @@ Promise<[ProductCollection](ProductCollection.mdx)> ___ -### delete +#### delete `**delete**(collectionId): Promise<void>` Deletes a product collection idempotently -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -383,13 +369,13 @@ Promise<void> ___ -### list +#### list `**list**(selector?, config?): Promise<[ProductCollection](ProductCollection.mdx)[]>` Lists product collections -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCollection](ProductCollection.mdx)[]> @@ -448,13 +434,13 @@ Promise<[ProductCollection](ProductCollection.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config?): Promise<[[ProductCollection](ProductCollection.mdx)[], number]>` Lists product collections and add count. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[ProductCollection](ProductCollection.mdx)[], number]> @@ -495,11 +481,11 @@ Promise<[[ProductCollection](ProductCollection.mdx)[], number]> ___ -### removeProducts +#### removeProducts `**removeProducts**(collectionId, productIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -540,13 +526,13 @@ Promise<void> ___ -### retrieve +#### retrieve `**retrieve**(collectionId, config?): Promise<[ProductCollection](ProductCollection.mdx)>` Retrieves a product collection by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCollection](ProductCollection.mdx)> @@ -587,13 +573,13 @@ Promise<[ProductCollection](ProductCollection.mdx)> ___ -### retrieveByHandle +#### retrieveByHandle `**retrieveByHandle**(collectionHandle, config?): Promise<[ProductCollection](ProductCollection.mdx)>` Retrieves a product collection by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCollection](ProductCollection.mdx)> @@ -634,11 +620,11 @@ Promise<[ProductCollection](ProductCollection.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -670,13 +656,13 @@ ___ ___ -### update +#### update `**update**(collectionId, update): Promise<[ProductCollection](ProductCollection.mdx)>` Updates a product collection -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductCollection](ProductCollection.mdx)> @@ -717,11 +703,11 @@ Promise<[ProductCollection](ProductCollection.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ProductCollectionService](ProductCollectionService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ProductCollectionService](ProductCollectionService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ProductOption.mdx b/www/apps/docs/content/references/services/classes/ProductOption.mdx index 6d1f7da9a5..08ce7d0d5d 100644 --- a/www/apps/docs/content/references/services/classes/ProductOption.mdx +++ b/www/apps/docs/content/references/services/classes/ProductOption.mdx @@ -10,7 +10,7 @@ A Product Option defines properties that may vary between different variants of ## Constructors -### constructor +#### constructor `**new ProductOption**()` @@ -104,11 +104,11 @@ A Product Option defines properties that may vary between different variants of ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx b/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx index b8ea4865d2..fe7dbd78af 100644 --- a/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx +++ b/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx @@ -10,7 +10,7 @@ An option value is one of the possible values of a Product Option. Product Varia ## Constructors -### constructor +#### constructor `**new ProductOptionValue**()` @@ -113,11 +113,11 @@ An option value is one of the possible values of a Product Option. Product Varia ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductService.mdx b/www/apps/docs/content/references/services/classes/ProductService.mdx index 6577f7365e..330d26f36d 100644 --- a/www/apps/docs/content/references/services/classes/ProductService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ProductService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addOption +#### addOption `**addOption**(productId, optionTitle): Promise<[Product](Product.mdx)>` @@ -252,7 +236,7 @@ Adds an option to a product. Options can, for example, be "Size", "Color", etc. Will update all the products variants with a dummy value for the newly created option. The same option cannot be added more than once. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -293,7 +277,7 @@ Promise<[Product](Product.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -301,6 +285,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -372,13 +358,13 @@ Promise<TResult> ___ -### count +#### count `**count**(selector?): Promise<number>` Return the total number of documents in database -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -410,13 +396,13 @@ Promise<number> ___ -### create +#### create `**create**(productObject): Promise<[Product](Product.mdx)>` Creates a product. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -448,14 +434,14 @@ Promise<[Product](Product.mdx)> ___ -### delete +#### delete `**delete**(productId): Promise<void>` Deletes a product from a given product id. The product's associated variants will also be deleted. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -487,13 +473,13 @@ Promise<void> ___ -### deleteOption +#### deleteOption `**deleteOption**(productId, optionId): Promise<void \| [Product](Product.mdx)>` Delete an option from a product. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [Product](Product.mdx)> @@ -534,11 +520,11 @@ Promise<void \| [Product](Product.mdx)> ___ -### filterProductsBySalesChannel +#### filterProductsBySalesChannel `**filterProductsBySalesChannel**(productIds, salesChannelId, config?): Promise<[Product](Product.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)[]> @@ -588,13 +574,13 @@ Promise<[Product](Product.mdx)[]> ___ -### isProductInSalesChannels +#### isProductInSalesChannels `**isProductInSalesChannels**(id, salesChannelIds): Promise<boolean>` Check if the product is assigned to at least one of the provided sales channels. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -635,13 +621,13 @@ Promise<boolean> ___ -### list +#### list `**list**(selector, config?): Promise<[Product](Product.mdx)[]>` Lists products based on the provided parameters. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)[]> @@ -682,14 +668,14 @@ Promise<[Product](Product.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Product](Product.mdx)[], number]>` Lists products based on the provided parameters and includes the count of products that match the query. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Product](Product.mdx)[], number]> @@ -730,11 +716,11 @@ Promise<[[Product](Product.mdx)[], number]> ___ -### listTagsByUsage +#### listTagsByUsage `**listTagsByUsage**(take?): Promise<[ProductTag](ProductTag.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductTag](ProductTag.mdx)[]> @@ -766,11 +752,11 @@ Promise<[ProductTag](ProductTag.mdx)[]> ___ -### listTypes +#### listTypes `**listTypes**(): Promise<[ProductType](ProductType.mdx)[]>` -#### Returns +##### Returns Promise<[ProductType](ProductType.mdx)[]> @@ -788,13 +774,13 @@ Promise<[ProductType](ProductType.mdx)[]> ___ -### prepareListQuery\_ +#### prepareListQuery\_ `Protected **prepareListQuery_**(selector, config): { q: string ; query: [FindWithoutRelationsOptions](../types/FindWithoutRelationsOptions-1.mdx) ; relations: keyof [Product](Product.mdx)[] }` Temporary method to be used in place we need custom query strategy to prevent typeorm bug -#### Parameters +##### Parameters -#### Returns +##### Returns `object` @@ -865,11 +851,11 @@ Temporary method to be used in place we need custom query strategy to prevent ty ___ -### reorderVariants +#### reorderVariants `**reorderVariants**(productId, variantOrder): Promise<[Product](Product.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -910,14 +896,14 @@ Promise<[Product](Product.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(productId, config?): Promise<[Product](Product.mdx)>` Gets a product by id. Throws in case of DB Error and if product was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -958,14 +944,14 @@ Promise<[Product](Product.mdx)> ___ -### retrieveByExternalId +#### retrieveByExternalId `**retrieveByExternalId**(externalId, config?): Promise<[Product](Product.mdx)>` Gets a product by external id. Throws in case of DB Error and if product was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -1006,14 +992,14 @@ Promise<[Product](Product.mdx)> ___ -### retrieveByHandle +#### retrieveByHandle `**retrieveByHandle**(productHandle, config?): Promise<[Product](Product.mdx)>` Gets a product by handle. Throws in case of DB Error and if product was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -1054,13 +1040,13 @@ Promise<[Product](Product.mdx)> ___ -### retrieveOptionByTitle +#### retrieveOptionByTitle `**retrieveOptionByTitle**(title, productId): Promise<null \| [ProductOption](ProductOption.mdx)>` Retrieve product's option by title. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<null \| [ProductOption](ProductOption.mdx)> @@ -1101,13 +1087,13 @@ Promise<null \| [ProductOption](ProductOption.mdx)> ___ -### retrieveVariants +#### retrieveVariants `**retrieveVariants**(productId, config?): Promise<[ProductVariant](ProductVariant.mdx)[]>` Gets all variants belonging to a product. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)[]> @@ -1148,14 +1134,14 @@ Promise<[ProductVariant](ProductVariant.mdx)[]> ___ -### retrieve\_ +#### retrieve\_ `**retrieve_**(selector, config?): Promise<[Product](Product.mdx)>` Gets a product by selector. Throws in case of DB Error and if product was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -1196,11 +1182,11 @@ Promise<[Product](Product.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1232,7 +1218,7 @@ ___ ___ -### update +#### update `**update**(productId, update): Promise<[Product](Product.mdx)>` @@ -1240,7 +1226,7 @@ Updates a product. Product variant updates should use dedicated methods, e.g. `addVariant`, etc. The function will throw errors if metadata or product variant updates are attempted. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -1281,14 +1267,14 @@ Promise<[Product](Product.mdx)> ___ -### updateOption +#### updateOption `**updateOption**(productId, optionId, data): Promise<[Product](Product.mdx)>` Updates a product's option. Throws if the call tries to update an option not associated with the product. Throws if the updated title already exists. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)> @@ -1338,13 +1324,13 @@ Promise<[Product](Product.mdx)> ___ -### updateShippingProfile +#### updateShippingProfile `**updateShippingProfile**(productIds, profileId): Promise<[Product](Product.mdx)[]>` Assign a product to a profile, if a profile id null is provided then detach the product from the profile -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Product](Product.mdx)[]> @@ -1385,11 +1371,11 @@ Promise<[Product](Product.mdx)[]> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ProductService](ProductService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ProductService](ProductService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ProductTag.mdx b/www/apps/docs/content/references/services/classes/ProductTag.mdx index bfe3e99fc5..8e51d8562e 100644 --- a/www/apps/docs/content/references/services/classes/ProductTag.mdx +++ b/www/apps/docs/content/references/services/classes/ProductTag.mdx @@ -10,7 +10,7 @@ A Product Tag can be added to Products for easy filtering and grouping. ## Constructors -### constructor +#### constructor `**new ProductTag**()` @@ -77,11 +77,11 @@ A Product Tag can be added to Products for easy filtering and grouping. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductTaxRate.mdx b/www/apps/docs/content/references/services/classes/ProductTaxRate.mdx index 75298a4ffb..9b7ba524bf 100644 --- a/www/apps/docs/content/references/services/classes/ProductTaxRate.mdx +++ b/www/apps/docs/content/references/services/classes/ProductTaxRate.mdx @@ -10,7 +10,7 @@ This represents the association between a tax rate and a product to indicate tha ## Constructors -### constructor +#### constructor `**new ProductTaxRate**()` diff --git a/www/apps/docs/content/references/services/classes/ProductType.mdx b/www/apps/docs/content/references/services/classes/ProductType.mdx index caee14a56b..ff2b6277e5 100644 --- a/www/apps/docs/content/references/services/classes/ProductType.mdx +++ b/www/apps/docs/content/references/services/classes/ProductType.mdx @@ -10,7 +10,7 @@ A Product Type can be added to Products for filtering and reporting purposes. ## Constructors -### constructor +#### constructor `**new ProductType**()` @@ -77,11 +77,11 @@ A Product Type can be added to Products for filtering and reporting purposes. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductTypeService.mdx b/www/apps/docs/content/references/services/classes/ProductTypeService.mdx index fdaa6d428c..534e175a2e 100644 --- a/www/apps/docs/content/references/services/classes/ProductTypeService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductTypeService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ProductTypeService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -117,6 +101,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -188,13 +174,13 @@ Promise<TResult> ___ -### list +#### list `**list**(selector?, config?): Promise<[ProductType](ProductType.mdx)[]>` Lists product types -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductType](ProductType.mdx)[]> @@ -235,13 +221,13 @@ Promise<[ProductType](ProductType.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config?): Promise<[[ProductType](ProductType.mdx)[], number]>` Lists product types and adds count. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[ProductType](ProductType.mdx)[], number]> @@ -282,14 +268,14 @@ Promise<[[ProductType](ProductType.mdx)[], number]> ___ -### retrieve +#### retrieve `**retrieve**(id, config?): Promise<[ProductType](ProductType.mdx)>` Gets a product type by id. Throws in case of DB Error and if product was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductType](ProductType.mdx)> @@ -330,11 +316,11 @@ Promise<[ProductType](ProductType.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -366,11 +352,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ProductTypeService](ProductTypeService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ProductTypeService](ProductTypeService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ProductTypeTaxRate.mdx b/www/apps/docs/content/references/services/classes/ProductTypeTaxRate.mdx index 6fe0c970a7..a60617e7dc 100644 --- a/www/apps/docs/content/references/services/classes/ProductTypeTaxRate.mdx +++ b/www/apps/docs/content/references/services/classes/ProductTypeTaxRate.mdx @@ -10,7 +10,7 @@ This represents the association between a tax rate and a product type to indicat ## Constructors -### constructor +#### constructor `**new ProductTypeTaxRate**()` diff --git a/www/apps/docs/content/references/services/classes/ProductVariant.mdx b/www/apps/docs/content/references/services/classes/ProductVariant.mdx index 1a15da7fc6..1b7bc27eb5 100644 --- a/www/apps/docs/content/references/services/classes/ProductVariant.mdx +++ b/www/apps/docs/content/references/services/classes/ProductVariant.mdx @@ -10,7 +10,7 @@ A Product Variant represents a Product with a specific set of Product Option con ## Constructors -### constructor +#### constructor `**new ProductVariant**()` @@ -275,11 +275,11 @@ A Product Variant represents a Product with a specific set of Product Option con ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx b/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx index 497188e7a0..dff7606e87 100644 --- a/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx +++ b/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx @@ -10,7 +10,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes ## Constructors -### constructor +#### constructor `**new ProductVariantInventoryItem**()` @@ -95,11 +95,11 @@ A Product Variant Inventory Item links variants with inventory items and denotes ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx b/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx index 68606ee9d2..229ead223e 100644 --- a/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ProductVariantInventoryService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ___ -### inventoryService\_ +#### inventoryService\_ -`Protected get**inventoryService_**(): [IInventoryService](../interfaces/IInventoryService.mdx)` - -#### Returns - -[IInventoryService](../interfaces/IInventoryService.mdx) - - Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<boolean>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../interfaces/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../interfaces/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../interfaces/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/Partial.mdx)<[CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../interfaces/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevels", - "type": "(`updates`: [BulkUpdateInventoryLevelInput](../interfaces/BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../interfaces/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> + `Protected` **inventoryService\_**: [object Object] ___ -### stockLocationService\_ +#### stockLocationService\_ -`Protected get**stockLocationService_**(): [IStockLocationService](../interfaces/IStockLocationService.mdx)` - -#### Returns - -[IStockLocationService](../interfaces/IStockLocationService.mdx) - - Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> + `Protected` **stockLocationService\_**: [object Object] ## Methods -### adjustInventory +#### adjustInventory `**adjustInventory**(variantId, locationId, quantity): Promise<void>` Adjusts inventory of a variant on a location -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -524,13 +188,13 @@ Promise<void> ___ -### adjustReservationsQuantityByLineItem +#### adjustReservationsQuantityByLineItem `**adjustReservationsQuantityByLineItem**(lineItemId, variantId, locationId, quantity): Promise<void>` Adjusts the quantity of reservations for a line item by a given amount. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -589,7 +253,7 @@ Promise<void> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -597,6 +261,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -668,13 +334,13 @@ Promise<TResult> ___ -### attachInventoryItem +#### attachInventoryItem `**attachInventoryItem**(attachments): Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]>` Attach a variant to an inventory item -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> @@ -706,7 +372,7 @@ Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> `**attachInventoryItem**(variantId, inventoryItemId, requiredQuantity?): Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> @@ -756,13 +422,13 @@ Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> ___ -### confirmInventory +#### confirmInventory `**confirmInventory**(variantId, quantity, context?): Promise<[Boolean](../index.md#boolean)>` confirms if requested inventory is available -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Boolean](../index.md#boolean)> @@ -821,13 +487,13 @@ Promise<[Boolean](../index.md#boolean)> ___ -### deleteReservationsByLineItem +#### deleteReservationsByLineItem `**deleteReservationsByLineItem**(lineItemId, variantId, quantity): Promise<void>` delete a reservation of variant quantity -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -877,13 +543,13 @@ Promise<void> ___ -### detachInventoryItem +#### detachInventoryItem `**detachInventoryItem**(inventoryItemId, variantId?): Promise<void>` Remove a variant from an inventory item -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -924,11 +590,11 @@ Promise<void> ___ -### getAvailabilityContext +#### getAvailabilityContext `Private **getAvailabilityContext**(variants, salesChannelId, existingContext?): Promise<[Required](../types/Required.mdx)<[AvailabilityContext](../types/AvailabilityContext.mdx)>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Required](../types/Required.mdx)<[AvailabilityContext](../types/AvailabilityContext.mdx)>> @@ -978,7 +644,7 @@ Promise<[Required](../types/Required.mdx)<[AvailabilityContext](../types ___ -### getVariantQuantityFromVariantInventoryItems +#### getVariantQuantityFromVariantInventoryItems `**getVariantQuantityFromVariantInventoryItems**(variantInventoryItems, channelId): Promise<number>` @@ -987,7 +653,7 @@ The inventory quantity of the variant should be equal to the inventory item with the smallest stock, adjusted for quantity required to fulfill the given variant. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1028,13 +694,13 @@ Promise<number> ___ -### listByItem +#### listByItem `**listByItem**(itemIds): Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]>` list registered inventory items -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> @@ -1066,13 +732,13 @@ Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> ___ -### listByVariant +#### listByVariant `**listByVariant**(variantId): Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]>` List inventory items for a specific variant -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> @@ -1104,13 +770,13 @@ Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]> ___ -### listInventoryItemsByVariant +#### listInventoryItemsByVariant `**listInventoryItemsByVariant**(variantId): Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>` lists inventory items for a given variant -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]> @@ -1142,13 +808,13 @@ Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]> ___ -### listVariantsByItem +#### listVariantsByItem `**listVariantsByItem**(itemId): Promise<[ProductVariant](ProductVariant.mdx)[]>` lists variant by inventory item id -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)[]> @@ -1180,13 +846,13 @@ Promise<[ProductVariant](ProductVariant.mdx)[]> ___ -### reserveQuantity +#### reserveQuantity `**reserveQuantity**(variantId, quantity, context?): Promise<void \| [ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>` Reserves a quantity of a variant -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [ReservationItemDTO](../types/ReservationItemDTO.mdx)[]> @@ -1236,13 +902,13 @@ Promise<void \| [ReservationItemDTO](../types/ReservationItemDTO.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(inventoryItemId, variantId): Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)>` Retrieves a product variant inventory item by its inventory item ID and variant ID. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)> @@ -1283,11 +949,11 @@ Promise<[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)> ___ -### setProductAvailability +#### setProductAvailability `**setProductAvailability**(products, salesChannelId): Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.mdx))[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.mdx))[]> @@ -1328,11 +994,11 @@ Promise<([Product](Product.mdx) \| [PricedProduct](../types/PricedProduct.md ___ -### setVariantAvailability +#### setVariantAvailability `**setVariantAvailability**(variants, salesChannelId, availabilityContext?): Promise<[ProductVariant](ProductVariant.mdx)[] \| [PricedVariant](../types/PricedVariant.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)[] \| [PricedVariant](../types/PricedVariant.mdx)[]> @@ -1382,11 +1048,11 @@ Promise<[ProductVariant](ProductVariant.mdx)[] \| [PricedVariant](../types/P ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1418,13 +1084,13 @@ ___ ___ -### validateInventoryAtLocation +#### validateInventoryAtLocation `**validateInventoryAtLocation**(items, locationId): Promise<void>` Validate stock at a location for fulfillment items -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1465,11 +1131,11 @@ Promise<void> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ProductVariantInventoryService](ProductVariantInventoryService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ProductVariantInventoryService](ProductVariantInventoryService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ProductVariantService.mdx b/www/apps/docs/content/references/services/classes/ProductVariantService.mdx index f617f59eef..5f726edd37 100644 --- a/www/apps/docs/content/references/services/classes/ProductVariantService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductVariantService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ProductVariantService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addOptionValue +#### addOptionValue `**addOptionValue**(variantId, optionId, optionValue): Promise<[ProductOptionValue](ProductOptionValue.mdx)>` @@ -218,7 +202,7 @@ if that product does not have an option with the given option id. Fails if given variant is not found. Option value must be of type string or number. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductOptionValue](ProductOptionValue.mdx)> @@ -268,7 +252,7 @@ Promise<[ProductOptionValue](ProductOptionValue.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -276,6 +260,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -347,13 +333,15 @@ Promise<TResult> ___ -### create +#### create `**create**(productOrProductId, variants): Promise<TOutput>` Creates an unpublished product variant. Will validate against parent product to ensure that the variant can in fact be created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TOutput> @@ -416,14 +404,14 @@ Promise<TOutput> ___ -### delete +#### delete `**delete**(variantIds): Promise<void>` Deletes variant or variants. Will never fail due to delete being idempotent. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -455,14 +443,14 @@ Promise<void> ___ -### deleteOptionValue +#### deleteOptionValue `**deleteOptionValue**(variantId, optionId): Promise<void>` Deletes option value from given variant. Will never fail due to delete being idempotent. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -503,14 +491,14 @@ Promise<void> ___ -### getFreeTextQueryBuilder\_ +#### getFreeTextQueryBuilder\_ `**getFreeTextQueryBuilder_**(variantRepo, query, q?): SelectQueryBuilder<[ProductVariant](ProductVariant.mdx)>` Lists variants based on the provided parameters and includes the count of variants that match the query. -#### Parameters +##### Parameters -#### Returns +##### Returns SelectQueryBuilder<[ProductVariant](ProductVariant.mdx)> @@ -560,7 +548,7 @@ SelectQueryBuilder<[ProductVariant](ProductVariant.mdx)> ___ -### getRegionPrice +#### getRegionPrice `**getRegionPrice**(variantId, context): Promise<null \| number>` @@ -568,7 +556,7 @@ Gets the price specific to a region. If no region specific money amount exists the function will try to use a currency price. If no default currency price exists the function will throw an error. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<null \| number> @@ -609,13 +597,13 @@ Promise<null \| number> ___ -### isVariantInSalesChannels +#### isVariantInSalesChannels `**isVariantInSalesChannels**(id, salesChannelIds): Promise<boolean>` Check if the variant is assigned to at least one of the provided sales channels. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -656,11 +644,11 @@ Promise<boolean> ___ -### list +#### list `**list**(selector, config?): Promise<[ProductVariant](ProductVariant.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)[]> @@ -701,11 +689,11 @@ Promise<[ProductVariant](ProductVariant.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[ProductVariant](ProductVariant.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[ProductVariant](ProductVariant.mdx)[], number]> @@ -746,13 +734,13 @@ Promise<[[ProductVariant](ProductVariant.mdx)[], number]> ___ -### retrieve +#### retrieve `**retrieve**(variantId, config?): Promise<[ProductVariant](ProductVariant.mdx)>` Gets a product variant by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)> @@ -793,13 +781,13 @@ Promise<[ProductVariant](ProductVariant.mdx)> ___ -### retrieveBySKU +#### retrieveBySKU `**retrieveBySKU**(sku, config?): Promise<[ProductVariant](ProductVariant.mdx)>` Gets a product variant by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)> @@ -840,11 +828,11 @@ Promise<[ProductVariant](ProductVariant.mdx)> ___ -### setCurrencyPrice +#### setCurrencyPrice `**setCurrencyPrice**(variantId, price): Promise<[MoneyAmount](MoneyAmount.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[MoneyAmount](MoneyAmount.mdx)> @@ -890,11 +878,11 @@ Sets the default price for the given currency. ___ -### setRegionPrice +#### setRegionPrice `**setRegionPrice**(variantId, price): Promise<[MoneyAmount](MoneyAmount.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[MoneyAmount](MoneyAmount.mdx)> @@ -940,11 +928,11 @@ Sets the default price of a specific region ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -976,13 +964,13 @@ ___ ___ -### update +#### update `**update**(variantData): Promise<[ProductVariant](ProductVariant.mdx)[]>` Updates a collection of variant. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)[]> @@ -1018,7 +1006,7 @@ Updates a variant. Price updates should use dedicated methods. The function will throw, if price updates are attempted. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)> @@ -1059,7 +1047,7 @@ Promise<[ProductVariant](ProductVariant.mdx)> `**update**(variantOrVariantId, update): Promise<[ProductVariant](ProductVariant.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)> @@ -1100,11 +1088,11 @@ Promise<[ProductVariant](ProductVariant.mdx)> ___ -### updateBatch +#### updateBatch `Protected **updateBatch**(variantData): Promise<[ProductVariant](ProductVariant.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductVariant](ProductVariant.mdx)[]> @@ -1136,14 +1124,14 @@ Promise<[ProductVariant](ProductVariant.mdx)[]> ___ -### updateOptionValue +#### updateOptionValue `**updateOptionValue**(variantId, optionId, optionValue): Promise<[ProductOptionValue](ProductOptionValue.mdx)>` Updates variant's option value. Option value must be of type string or number. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductOptionValue](ProductOptionValue.mdx)> @@ -1193,14 +1181,14 @@ Promise<[ProductOptionValue](ProductOptionValue.mdx)> ___ -### updateVariantPrices +#### updateVariantPrices `**updateVariantPrices**(data): Promise<void>` Updates variant/prices collection. Deletes any prices that are not in the update object, and is not associated with a price list. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1235,7 +1223,7 @@ Promise<void> Updates a variant's prices. Deletes any prices that are not in the update object, and is not associated with a price list. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1276,11 +1264,11 @@ Promise<void> ___ -### updateVariantPricesBatch +#### updateVariantPricesBatch `Protected **updateVariantPricesBatch**(data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1312,11 +1300,11 @@ Promise<void> ___ -### upsertCurrencyPrices +#### upsertCurrencyPrices `**upsertCurrencyPrices**(data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1348,11 +1336,11 @@ Promise<void> ___ -### upsertRegionPrices +#### upsertRegionPrices `**upsertRegionPrices**(data): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1384,11 +1372,11 @@ Promise<void> ___ -### validateVariantsToCreate\_ +#### validateVariantsToCreate\_ `Protected **validateVariantsToCreate_**(product, variants): void` -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -1429,11 +1417,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ProductVariantService](ProductVariantService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ProductVariantService](ProductVariantService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Refund.mdx b/www/apps/docs/content/references/services/classes/Refund.mdx index 7550da7579..c0e3115da5 100644 --- a/www/apps/docs/content/references/services/classes/Refund.mdx +++ b/www/apps/docs/content/references/services/classes/Refund.mdx @@ -10,7 +10,7 @@ A refund represents an amount of money transfered back to the customer for a giv ## Constructors -### constructor +#### constructor `**new Refund**()` @@ -131,11 +131,11 @@ A refund represents an amount of money transfered back to the customer for a giv ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/Region.mdx b/www/apps/docs/content/references/services/classes/Region.mdx index 5ce43f8429..c173c792f5 100644 --- a/www/apps/docs/content/references/services/classes/Region.mdx +++ b/www/apps/docs/content/references/services/classes/Region.mdx @@ -10,7 +10,7 @@ A region holds settings specific to a geographical location, including the curre ## Constructors -### constructor +#### constructor `**new Region**()` @@ -195,11 +195,11 @@ A region holds settings specific to a geographical location, including the curre ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/RegionService.mdx b/www/apps/docs/content/references/services/classes/RegionService.mdx index 00395d7bfb..c7098252bb 100644 --- a/www/apps/docs/content/references/services/classes/RegionService.mdx +++ b/www/apps/docs/content/references/services/classes/RegionService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate regions. ## Constructors -### constructor +#### constructor `**new RegionService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addCountry +#### addCountry `**addCountry**(regionId, code): Promise<[Region](Region.mdx)>` Adds a country to the region. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -284,14 +268,14 @@ Promise<[Region](Region.mdx)> ___ -### addFulfillmentProvider +#### addFulfillmentProvider `**addFulfillmentProvider**(regionId, providerId): Promise<[Region](Region.mdx)>` Adds a fulfillment provider that is available in the region. Fails if the provider doesn't exist. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -332,14 +316,14 @@ Promise<[Region](Region.mdx)> ___ -### addPaymentProvider +#### addPaymentProvider `**addPaymentProvider**(regionId, providerId): Promise<[Region](Region.mdx)>` Adds a payment provider that is available in the region. Fails if the provider doesn't exist. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -380,7 +364,7 @@ Promise<[Region](Region.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -388,6 +372,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -459,13 +445,13 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[Region](Region.mdx)>` Creates a region. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -497,13 +483,13 @@ Promise<[Region](Region.mdx)> ___ -### delete +#### delete `**delete**(regionId): Promise<void>` Deletes a region. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -535,13 +521,13 @@ Promise<void> ___ -### list +#### list `**list**(selector?, config?): Promise<[Region](Region.mdx)[]>` Lists all regions based on a query -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)[]> @@ -582,13 +568,13 @@ Promise<[Region](Region.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector?, config?): Promise<[[Region](Region.mdx)[], number]>` Lists all regions based on a query and returns them along with count -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Region](Region.mdx)[], number]> @@ -629,13 +615,13 @@ Promise<[[Region](Region.mdx)[], number]> ___ -### removeCountry +#### removeCountry `**removeCountry**(regionId, code): Promise<[Region](Region.mdx)>` Removes a country from a Region. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -676,13 +662,13 @@ Promise<[Region](Region.mdx)> ___ -### removeFulfillmentProvider +#### removeFulfillmentProvider `**removeFulfillmentProvider**(regionId, providerId): Promise<[Region](Region.mdx)>` Removes a fulfillment provider from a region. Is idempotent. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -723,13 +709,13 @@ Promise<[Region](Region.mdx)> ___ -### removePaymentProvider +#### removePaymentProvider `**removePaymentProvider**(regionId, providerId): Promise<[Region](Region.mdx)>` Removes a payment provider from a region. Is idempotent. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -770,13 +756,13 @@ Promise<[Region](Region.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(regionId, config?): Promise<[Region](Region.mdx)>` Retrieves a region by its id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -817,13 +803,13 @@ Promise<[Region](Region.mdx)> ___ -### retrieveByCountryCode +#### retrieveByCountryCode `**retrieveByCountryCode**(code, config?): Promise<[Region](Region.mdx)>` Retrieve a region by country code. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -864,13 +850,13 @@ Promise<[Region](Region.mdx)> ___ -### retrieveByName +#### retrieveByName `**retrieveByName**(name): Promise<[Region](Region.mdx)>` Retrieves a region by name. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -902,11 +888,11 @@ Promise<[Region](Region.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -938,13 +924,13 @@ ___ ___ -### update +#### update `**update**(regionId, update): Promise<[Region](Region.mdx)>` Updates a region -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Region](Region.mdx)> @@ -985,14 +971,14 @@ Promise<[Region](Region.mdx)> ___ -### validateCountry +#### validateCountry `Protected **validateCountry**(code, regionId): Promise<[Country](Country.mdx)>` Validates a country code. Will normalize the code before checking for existence. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Country](Country.mdx)> @@ -1033,13 +1019,13 @@ Promise<[Country](Country.mdx)> ___ -### validateCurrency +#### validateCurrency `Protected **validateCurrency**(currencyCode): Promise<void>` Validates a currency code. Will throw if the currency code doesn't exist. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1075,13 +1061,15 @@ if the provided currency code is invalid ___ -### validateFields +#### validateFields `Protected **validateFields**(regionData, id?): Promise<DeepPartial<[Region](Region.mdx)>>` Validates fields for creation and updates. If the region already exists the id can be passed to check that country updates are allowed. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<DeepPartial<[Region](Region.mdx)>> @@ -1135,13 +1123,13 @@ Promise<DeepPartial<[Region](Region.mdx)>> ___ -### validateTaxRate +#### validateTaxRate `Protected **validateTaxRate**(taxRate): void` Validates a tax rate. Will throw if the tax rate is not between 0 and 1. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -1177,11 +1165,11 @@ if the tax rate isn't number between 0-100 ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [RegionService](RegionService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [RegionService](RegionService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Return.mdx b/www/apps/docs/content/references/services/classes/Return.mdx index 730f41204d..cc1ceccad9 100644 --- a/www/apps/docs/content/references/services/classes/Return.mdx +++ b/www/apps/docs/content/references/services/classes/Return.mdx @@ -10,7 +10,7 @@ A Return holds information about Line Items that a Customer wishes to send back, ## Constructors -### constructor +#### constructor `**new Return**()` @@ -194,11 +194,11 @@ A Return holds information about Line Items that a Customer wishes to send back, ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ReturnItem.mdx b/www/apps/docs/content/references/services/classes/ReturnItem.mdx index 73174ecea5..e8d2301cd3 100644 --- a/www/apps/docs/content/references/services/classes/ReturnItem.mdx +++ b/www/apps/docs/content/references/services/classes/ReturnItem.mdx @@ -10,7 +10,7 @@ A return item represents a line item in an order that is to be returned. It incl ## Constructors -### constructor +#### constructor `**new ReturnItem**()` diff --git a/www/apps/docs/content/references/services/classes/ReturnReason.mdx b/www/apps/docs/content/references/services/classes/ReturnReason.mdx index aefbd8b891..09d897dfc1 100644 --- a/www/apps/docs/content/references/services/classes/ReturnReason.mdx +++ b/www/apps/docs/content/references/services/classes/ReturnReason.mdx @@ -10,7 +10,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i ## Constructors -### constructor +#### constructor `**new ReturnReason**()` @@ -122,11 +122,11 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx b/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx index e2d2a1828d..8c6c28f2d2 100644 --- a/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx +++ b/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ReturnReasonService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -117,6 +101,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -188,11 +174,11 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[ReturnReason](ReturnReason.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnReason](ReturnReason.mdx)> @@ -224,11 +210,11 @@ Promise<[ReturnReason](ReturnReason.mdx)> ___ -### delete +#### delete `**delete**(returnReasonId): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -260,11 +246,11 @@ Promise<void> ___ -### list +#### list `**list**(selector, config?): Promise<[ReturnReason](ReturnReason.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnReason](ReturnReason.mdx)[]> @@ -305,13 +291,13 @@ Promise<[ReturnReason](ReturnReason.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(returnReasonId, config?): Promise<[ReturnReason](ReturnReason.mdx)>` Gets an order by id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnReason](ReturnReason.mdx)> @@ -352,11 +338,11 @@ Promise<[ReturnReason](ReturnReason.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -388,11 +374,11 @@ ___ ___ -### update +#### update `**update**(id, data): Promise<[ReturnReason](ReturnReason.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnReason](ReturnReason.mdx)> @@ -433,11 +419,11 @@ Promise<[ReturnReason](ReturnReason.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ReturnReasonService](ReturnReasonService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ReturnReasonService](ReturnReasonService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ReturnService.mdx b/www/apps/docs/content/references/services/classes/ReturnService.mdx index 1a997b157c..e735f70115 100644 --- a/www/apps/docs/content/references/services/classes/ReturnService.mdx +++ b/www/apps/docs/content/references/services/classes/ReturnService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new ReturnService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -207,6 +191,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -278,13 +264,13 @@ Promise<TResult> ___ -### cancel +#### cancel `**cancel**(returnId): Promise<[Return](Return.mdx)>` Cancels a return if possible. Returns can be canceled if it has not been received. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)> @@ -316,7 +302,7 @@ Promise<[Return](Return.mdx)> ___ -### create +#### create `**create**(data): Promise<[Return](Return.mdx)>` @@ -324,7 +310,7 @@ Creates a return request for an order, with given items, and a shipping method. If no refund amount is provided the refund amount is calculated from the return lines and the shipping cost. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)> @@ -356,11 +342,11 @@ Promise<[Return](Return.mdx)> ___ -### fulfill +#### fulfill `**fulfill**(returnId): Promise<[Return](Return.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)> @@ -392,13 +378,13 @@ Promise<[Return](Return.mdx)> ___ -### getFulfillmentItems +#### getFulfillmentItems `Protected **getFulfillmentItems**(order, items, transformer): Promise<[LineItem](LineItem.mdx) & { note?: string ; reason_id?: string }[]>` Retrieves the order line items, given an array of items -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItem](LineItem.mdx) & { note?: string ; reason_id?: string }[]> @@ -448,11 +434,11 @@ Promise<[LineItem](LineItem.mdx) & { note?: string ; reason_id?: string ___ -### list +#### list `**list**(selector, config?): Promise<[Return](Return.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)[]> @@ -493,11 +479,11 @@ Promise<[Return](Return.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Return](Return.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Return](Return.mdx)[], number]> @@ -538,7 +524,7 @@ Promise<[[Return](Return.mdx)[], number]> ___ -### receive +#### receive `**receive**(returnId, receivedItems, refundAmount?, allowMismatch?, context?): Promise<[Return](Return.mdx)>` @@ -550,7 +536,7 @@ returned items are not matching the requested items. Setting the allowMismatch argument to true, will process the return, ignoring any mismatches. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)> @@ -627,13 +613,13 @@ Promise<[Return](Return.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(returnId, config?): Promise<[Return](Return.mdx)>` Retrieves a return by its id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)> @@ -674,11 +660,11 @@ Promise<[Return](Return.mdx)> ___ -### retrieveBySwap +#### retrieveBySwap `**retrieveBySwap**(swapId, relations?): Promise<[Return](Return.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)> @@ -719,11 +705,11 @@ Promise<[Return](Return.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -755,11 +741,11 @@ ___ ___ -### update +#### update `**update**(returnId, update): Promise<[Return](Return.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Return](Return.mdx)> @@ -800,7 +786,7 @@ Promise<[Return](Return.mdx)> ___ -### validateReturnLineItem +#### validateReturnLineItem `Protected **validateReturnLineItem**(item?, quantity?, additional?): DeepPartial<[LineItem](LineItem.mdx)>` @@ -808,7 +794,7 @@ Checks that a given quantity of a line item can be returned. Fails if the item is undefined or if the returnable quantity of the item is lower, than the quantity that is requested to be returned. -#### Parameters +##### Parameters -#### Returns +##### Returns DeepPartial<[LineItem](LineItem.mdx)> @@ -876,7 +862,7 @@ DeepPartial<[LineItem](LineItem.mdx)> ___ -### validateReturnStatuses +#### validateReturnStatuses `Protected **validateReturnStatuses**(order): void` @@ -884,7 +870,7 @@ Checks that an order has the statuses necessary to complete a return. fulfillment\_status cannot be not\_fulfilled or returned. payment\_status must be captured. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -920,11 +906,11 @@ when statuses are not sufficient for returns. ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ReturnService](ReturnService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ReturnService](ReturnService.mdx) diff --git a/www/apps/docs/content/references/services/classes/SalesChannel.mdx b/www/apps/docs/content/references/services/classes/SalesChannel.mdx index d183127cce..e297467ad0 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannel.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannel.mdx @@ -10,7 +10,7 @@ A Sales Channel is a method a business offers its products for purchase for the ## Constructors -### constructor +#### constructor `**new SalesChannel**()` @@ -104,11 +104,11 @@ A Sales Channel is a method a business offers its products for purchase for the ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx b/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx index 5e5686e0ba..39ed7a349a 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new SalesChannelInventoryService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ___ -### inventoryService\_ +#### inventoryService\_ -`Protected get**inventoryService_**(): [IInventoryService](../interfaces/IInventoryService.mdx)` - -#### Returns - -[IInventoryService](../interfaces/IInventoryService.mdx) - - Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<boolean>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../interfaces/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../interfaces/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../interfaces/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/Partial.mdx)<[CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../interfaces/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateInventoryLevels", - "type": "(`updates`: [BulkUpdateInventoryLevelInput](../interfaces/BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../interfaces/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> + `Protected` **inventoryService\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -391,6 +116,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -462,13 +189,13 @@ Promise<TResult> ___ -### retrieveAvailableItemQuantity +#### retrieveAvailableItemQuantity `**retrieveAvailableItemQuantity**(salesChannelId, inventoryItemId): Promise<number>` Retrieves the available quantity of an item across all sales channel locations -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -509,11 +236,11 @@ Promise<number> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -545,11 +272,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [SalesChannelInventoryService](SalesChannelInventoryService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [SalesChannelInventoryService](SalesChannelInventoryService.mdx) diff --git a/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx b/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx index a7ebb91433..b83f71fe32 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx @@ -10,7 +10,7 @@ This represents the association between a sales channel and a stock locations. ## Constructors -### constructor +#### constructor `**new SalesChannelLocation**()` @@ -86,11 +86,11 @@ This represents the association between a sales channel and a stock locations. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx b/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx index 730cc58e3d..fb83907395 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx @@ -10,11 +10,11 @@ Service for managing the stock locations of sales channels ## Constructors -### constructor +#### constructor `**new SalesChannelLocationService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ___ -### stockLocationService\_ +#### stockLocationService\_ -`Protected get**stockLocationService_**(): [IStockLocationService](../interfaces/IStockLocationService.mdx)` - -#### Returns - -[IStockLocationService](../interfaces/IStockLocationService.mdx) - - Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> + `Protected` **stockLocationService\_**: [object Object] ## Methods -### associateLocation +#### associateLocation `**associateLocation**(salesChannelId, locationId): Promise<void>` Associates a sales channel with a stock location. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -234,7 +157,7 @@ Promise<void> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -242,6 +165,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -313,13 +238,13 @@ Promise<TResult> ___ -### listLocationIds +#### listLocationIds `**listLocationIds**(salesChannelId): Promise<string[]>` Lists the stock locations associated with a sales channel. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string[]> @@ -351,13 +276,13 @@ Promise<string[]> ___ -### listSalesChannelIds +#### listSalesChannelIds `**listSalesChannelIds**(locationId): Promise<string[]>` Lists the sales channels associated with a stock location. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string[]> @@ -389,13 +314,13 @@ Promise<string[]> ___ -### removeLocation +#### removeLocation `**removeLocation**(locationId, salesChannelId?): Promise<void>` Removes an association between a sales channel and a stock location. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -436,11 +361,11 @@ Promise<void> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -472,11 +397,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [SalesChannelLocationService](SalesChannelLocationService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [SalesChannelLocationService](SalesChannelLocationService.mdx) diff --git a/www/apps/docs/content/references/services/classes/SalesChannelService.mdx b/www/apps/docs/content/references/services/classes/SalesChannelService.mdx index 9f94071731..b6af21edd2 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelService.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new SalesChannelService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addProducts +#### addProducts `**addProducts**(salesChannelId, productIds): Promise<[SalesChannel](SalesChannel.mdx)>` Add a batch of product to a sales channel -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -210,7 +194,7 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -218,6 +202,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -289,7 +275,7 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[SalesChannel](SalesChannel.mdx)>` @@ -298,7 +284,7 @@ Creates a SalesChannel This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -330,13 +316,13 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### createDefault +#### createDefault `**createDefault**(): Promise<[SalesChannel](SalesChannel.mdx)>` Creates a default sales channel, if this does not already exist. -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -354,7 +340,7 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### delete +#### delete `**delete**(salesChannelId): Promise<void>` @@ -362,7 +348,7 @@ Deletes a sales channel from This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -394,14 +380,14 @@ Promise<void> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[SalesChannel](SalesChannel.mdx)[], number]>` Lists sales channels based on the provided parameters and includes the count of sales channels that match the query. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[SalesChannel](SalesChannel.mdx)[], number]> @@ -442,13 +428,13 @@ Promise<[[SalesChannel](SalesChannel.mdx)[], number]> ___ -### listProductIdsBySalesChannelIds +#### listProductIdsBySalesChannelIds `**listProductIdsBySalesChannelIds**(salesChannelIds): Promise<{ [salesChannelId: string]: string[]; }>` List all product ids that belongs to the sales channels ids -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ [salesChannelId: string]: string[]; }> @@ -480,13 +466,13 @@ Promise<{ [salesChannelId: string]: string[]; }> ___ -### removeProducts +#### removeProducts `**removeProducts**(salesChannelId, productIds): Promise<[SalesChannel](SalesChannel.mdx)>` Remove a batch of product from a sales channel -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -527,13 +513,13 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(salesChannelId, config?): Promise<[SalesChannel](SalesChannel.mdx)>` Retrieve a SalesChannel by id -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -574,13 +560,13 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### retrieveByName +#### retrieveByName `**retrieveByName**(name, config?): Promise<unknown>` Find a sales channel by name. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<unknown> @@ -621,13 +607,13 @@ Promise<unknown> ___ -### retrieveDefault +#### retrieveDefault `**retrieveDefault**(): Promise<[SalesChannel](SalesChannel.mdx)>` Retrieves the default sales channel. -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -645,13 +631,13 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### retrieve\_ +#### retrieve\_ `Protected **retrieve_**(selector, config?): Promise<[SalesChannel](SalesChannel.mdx)>` A generic retrieve used to find a sales channel by different attributes. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -692,11 +678,11 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -728,11 +714,11 @@ ___ ___ -### update +#### update `**update**(salesChannelId, data): Promise<[SalesChannel](SalesChannel.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[SalesChannel](SalesChannel.mdx)> @@ -773,11 +759,11 @@ Promise<[SalesChannel](SalesChannel.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [SalesChannelService](SalesChannelService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [SalesChannelService](SalesChannelService.mdx) diff --git a/www/apps/docs/content/references/services/classes/SearchService.mdx b/www/apps/docs/content/references/services/classes/SearchService.mdx index 37b2c4e162..95111768af 100644 --- a/www/apps/docs/content/references/services/classes/SearchService.mdx +++ b/www/apps/docs/content/references/services/classes/SearchService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new SearchService**(«destructured», options)` -#### Parameters +##### Parameters ` - -`", - "optional": false, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } -]} /> + **options**: [object Object] ## Methods -### addDocuments +#### addDocuments `**addDocuments**(indexName, documents, type): Promise<void>` Used to index documents by the search engine provider -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -147,13 +131,13 @@ Promise<void> ___ -### createIndex +#### createIndex `**createIndex**(indexName, options): Promise<void>` Used to create an index -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -194,13 +178,13 @@ Promise<void> ___ -### deleteAllDocuments +#### deleteAllDocuments `**deleteAllDocuments**(indexName): Promise<void>` Used to delete all documents -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -232,13 +216,13 @@ Promise<void> ___ -### deleteDocument +#### deleteDocument `**deleteDocument**(indexName, document_id): Promise<void>` Used to delete document -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -279,13 +263,13 @@ Promise<void> ___ -### getIndex +#### getIndex `**getIndex**(indexName): Promise<void>` Used to get an index -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -317,13 +301,13 @@ Promise<void> ___ -### replaceDocuments +#### replaceDocuments `**replaceDocuments**(indexName, documents, type): Promise<void>` Used to replace documents -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -373,13 +357,13 @@ Promise<void> ___ -### search +#### search `**search**(indexName, query, options): Promise<{ hits: unknown[] }>` Used to search for a document in an index -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ hits: unknown[] }> @@ -429,13 +413,13 @@ Promise<{ hits: unknown[] }> ___ -### updateSettings +#### updateSettings `**updateSettings**(indexName, settings): Promise<void>` Used to update the settings of an index -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> diff --git a/www/apps/docs/content/references/services/classes/ShippingMethod.mdx b/www/apps/docs/content/references/services/classes/ShippingMethod.mdx index 4d7c2eaedc..599fc9f70a 100644 --- a/www/apps/docs/content/references/services/classes/ShippingMethod.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingMethod.mdx @@ -10,7 +10,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S ## Constructors -### constructor +#### constructor `**new ShippingMethod**()` @@ -204,11 +204,11 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx b/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx index 5207dc9eb3..876173f735 100644 --- a/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx @@ -10,7 +10,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in ## Constructors -### constructor +#### constructor `**new ShippingMethodTaxLine**()` @@ -104,11 +104,11 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ShippingOption.mdx b/www/apps/docs/content/references/services/classes/ShippingOption.mdx index 1a13dfbb18..6d0c9ae6ab 100644 --- a/www/apps/docs/content/references/services/classes/ShippingOption.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingOption.mdx @@ -10,7 +10,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S ## Constructors -### constructor +#### constructor `**new ShippingOption**()` @@ -195,11 +195,11 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ShippingOptionRequirement.mdx b/www/apps/docs/content/references/services/classes/ShippingOptionRequirement.mdx index 91eed97e9a..280008afa8 100644 --- a/www/apps/docs/content/references/services/classes/ShippingOptionRequirement.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingOptionRequirement.mdx @@ -10,7 +10,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th ## Constructors -### constructor +#### constructor `**new ShippingOptionRequirement**()` @@ -77,11 +77,11 @@ A shipping option requirement defines conditions that a Cart must satisfy for th ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ShippingOptionService.mdx b/www/apps/docs/content/references/services/classes/ShippingOptionService.mdx index 0af2148738..04616f28e3 100644 --- a/www/apps/docs/content/references/services/classes/ShippingOptionService.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingOptionService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate profiles. ## Constructors -### constructor +#### constructor `**new ShippingOptionService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addRequirement +#### addRequirement `**addRequirement**(optionId, requirement): Promise<[ShippingOption](ShippingOption.mdx)>` Adds a requirement to a shipping option. Only 1 requirement of each type is allowed. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOption](ShippingOption.mdx)> @@ -204,7 +188,7 @@ Promise<[ShippingOption](ShippingOption.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -212,6 +196,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -283,7 +269,7 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[ShippingOption](ShippingOption.mdx)>` @@ -291,7 +277,7 @@ Creates a new shipping option. Used both for outbound and inbound shipping options. The difference is registered by the `is_return` field which defaults to false. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOption](ShippingOption.mdx)> @@ -323,13 +309,13 @@ Promise<[ShippingOption](ShippingOption.mdx)> ___ -### createShippingMethod +#### createShippingMethod `**createShippingMethod**(optionId, data, config): Promise<[ShippingMethod](ShippingMethod.mdx)>` Creates a shipping method for a given cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingMethod](ShippingMethod.mdx)> @@ -379,13 +365,13 @@ Promise<[ShippingMethod](ShippingMethod.mdx)> ___ -### delete +#### delete `**delete**(optionId): Promise<void \| [ShippingOption](ShippingOption.mdx)>` Deletes a profile with a given profile id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [ShippingOption](ShippingOption.mdx)> @@ -417,13 +403,13 @@ Promise<void \| [ShippingOption](ShippingOption.mdx)> ___ -### deleteShippingMethods +#### deleteShippingMethods `**deleteShippingMethods**(shippingMethods): Promise<[ShippingMethod](ShippingMethod.mdx)[]>` Removes a given shipping method -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingMethod](ShippingMethod.mdx)[]> @@ -455,7 +441,7 @@ Promise<[ShippingMethod](ShippingMethod.mdx)[]> ___ -### getPrice\_ +#### getPrice\_ `**getPrice_**(option, data, cart): Promise<number>` @@ -463,7 +449,7 @@ Returns the amount to be paid for a shipping method. Will ask the fulfillment provider to calculate the price if the shipping option has the price type "calculated". -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -513,11 +499,11 @@ Promise<number> ___ -### list +#### list `**list**(selector, config?): Promise<[ShippingOption](ShippingOption.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOption](ShippingOption.mdx)[]> @@ -558,11 +544,11 @@ Promise<[ShippingOption](ShippingOption.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[ShippingOption](ShippingOption.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[ShippingOption](ShippingOption.mdx)[], number]> @@ -603,13 +589,13 @@ Promise<[[ShippingOption](ShippingOption.mdx)[], number]> ___ -### removeRequirement +#### removeRequirement `**removeRequirement**(requirementId): Promise<void \| [ShippingOptionRequirement](ShippingOptionRequirement.mdx)>` Removes a requirement from a shipping option -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [ShippingOptionRequirement](ShippingOptionRequirement.mdx)> @@ -641,14 +627,14 @@ Promise<void \| [ShippingOptionRequirement](ShippingOptionRequirement.mdx)&# ___ -### retrieve +#### retrieve `**retrieve**(optionId, options?): Promise<[ShippingOption](ShippingOption.mdx)>` Gets a profile by id. Throws in case of DB Error and if profile was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOption](ShippingOption.mdx)> @@ -689,11 +675,11 @@ Promise<[ShippingOption](ShippingOption.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -725,7 +711,7 @@ ___ ___ -### update +#### update `**update**(optionId, update): Promise<[ShippingOption](ShippingOption.mdx)>` @@ -733,7 +719,7 @@ Updates a profile. Metadata updates and product updates should use dedicated methods, e.g. `setMetadata`, etc. The function will throw errors if metadata or product updates are attempted. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOption](ShippingOption.mdx)> @@ -774,14 +760,14 @@ Promise<[ShippingOption](ShippingOption.mdx)> ___ -### updateShippingMethod +#### updateShippingMethod `**updateShippingMethod**(id, update): Promise<undefined \| [ShippingMethod](ShippingMethod.mdx)>` Updates a shipping method's associations. Useful when a cart is completed and its methods should be copied to an order/swap entity. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<undefined \| [ShippingMethod](ShippingMethod.mdx)> @@ -822,11 +808,11 @@ Promise<undefined \| [ShippingMethod](ShippingMethod.mdx)> ___ -### updateShippingProfile +#### updateShippingProfile `**updateShippingProfile**(optionIds, profileId): Promise<[ShippingOption](ShippingOption.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOption](ShippingOption.mdx)[]> @@ -867,11 +853,11 @@ Promise<[ShippingOption](ShippingOption.mdx)[]> ___ -### validateAndMutatePrice +#### validateAndMutatePrice `Private **validateAndMutatePrice**(option, priceInput): Promise<[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)<[ShippingOption](ShippingOption.mdx), "beforeInsert">>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)<[ShippingOption](ShippingOption.mdx), "beforeInsert">> @@ -912,7 +898,7 @@ Promise<[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) ___ -### validateCartOption +#### validateCartOption `**validateCartOption**(option, cart): Promise<null \| [ShippingOption](ShippingOption.mdx)>` @@ -920,7 +906,7 @@ Checks if a given option id is a valid option for a cart. If it is the option is returned with the correct price. Throws when region\_ids do not match, or when the shipping option requirements are not satisfied. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<null \| [ShippingOption](ShippingOption.mdx)> @@ -961,13 +947,13 @@ Promise<null \| [ShippingOption](ShippingOption.mdx)> ___ -### validatePriceType\_ +#### validatePriceType\_ `**validatePriceType_**(priceType, option): Promise<[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)>` Validates a shipping option price -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)> @@ -1008,13 +994,13 @@ Promise<[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)> ___ -### validateRequirement\_ +#### validateRequirement\_ `**validateRequirement_**(requirement, optionId?): Promise<[ShippingOptionRequirement](ShippingOptionRequirement.mdx)>` Validates a requirement -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOptionRequirement](ShippingOptionRequirement.mdx)> @@ -1055,11 +1041,11 @@ Promise<[ShippingOptionRequirement](ShippingOptionRequirement.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ShippingOptionService](ShippingOptionService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ShippingOptionService](ShippingOptionService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ShippingProfile.mdx b/www/apps/docs/content/references/services/classes/ShippingProfile.mdx index 45db8f4e05..04810f8a75 100644 --- a/www/apps/docs/content/references/services/classes/ShippingProfile.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingProfile.mdx @@ -10,7 +10,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful ## Constructors -### constructor +#### constructor `**new ShippingProfile**()` @@ -104,11 +104,11 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/ShippingProfileService.mdx b/www/apps/docs/content/references/services/classes/ShippingProfileService.mdx index 665430d7a2..76b0d3d093 100644 --- a/www/apps/docs/content/references/services/classes/ShippingProfileService.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingProfileService.mdx @@ -12,11 +12,11 @@ Provides layer to manipulate profiles. ## Constructors -### constructor +#### constructor `**new ShippingProfileService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addProduct +#### addProduct `**addProduct**(profileId, productId): Promise<[ShippingProfile](ShippingProfile.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -207,13 +191,13 @@ use [addProducts](ShippingProfileService.mdx#addproducts) instead ___ -### addProducts +#### addProducts `**addProducts**(profileId, productId): Promise<[ShippingProfile](ShippingProfile.mdx)>` Adds a product or an array of products to the profile. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -254,14 +238,14 @@ Promise<[ShippingProfile](ShippingProfile.mdx)> ___ -### addShippingOption +#### addShippingOption `**addShippingOption**(profileId, optionId): Promise<[ShippingProfile](ShippingProfile.mdx)>` Adds a shipping option to the profile. The shipping option can be used to fulfill the products in the products field. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -302,7 +286,7 @@ Promise<[ShippingProfile](ShippingProfile.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -310,6 +294,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -381,13 +367,13 @@ Promise<TResult> ___ -### create +#### create `**create**(profile): Promise<[ShippingProfile](ShippingProfile.mdx)>` Creates a new shipping profile. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -419,13 +405,13 @@ Promise<[ShippingProfile](ShippingProfile.mdx)> ___ -### createDefault +#### createDefault `**createDefault**(): Promise<[ShippingProfile](ShippingProfile.mdx)>` Creates a default shipping profile, if this does not already exist. -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -443,14 +429,14 @@ Promise<[ShippingProfile](ShippingProfile.mdx)> ___ -### createGiftCardDefault +#### createGiftCardDefault `**createGiftCardDefault**(): Promise<[ShippingProfile](ShippingProfile.mdx)>` Creates a default shipping profile, for gift cards if unless it already exists. -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -468,13 +454,13 @@ Promise<[ShippingProfile](ShippingProfile.mdx)> ___ -### delete +#### delete `**delete**(profileId): Promise<void>` Deletes a profile with a given profile id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -506,14 +492,14 @@ Promise<void> ___ -### fetchCartOptions +#### fetchCartOptions `**fetchCartOptions**(cart): Promise<[ShippingOption](ShippingOption.mdx)[]>` Finds all the shipping profiles that cover the products in a cart, and validates all options that are available for the cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingOption](ShippingOption.mdx)[]> @@ -545,11 +531,11 @@ Promise<[ShippingOption](ShippingOption.mdx)[]> ___ -### getMapProfileIdsByProductIds +#### getMapProfileIdsByProductIds `**getMapProfileIdsByProductIds**(productIds): Promise<Map<string, string>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Map<string, string>> @@ -581,13 +567,13 @@ Promise<Map<string, string>> ___ -### getProfilesInCart +#### getProfilesInCart `Protected **getProfilesInCart**(cart): Promise<string[]>` Returns a list of all the productIds in the cart. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string[]> @@ -619,11 +605,11 @@ Promise<string[]> ___ -### list +#### list `**list**(selector?, config?): Promise<[ShippingProfile](ShippingProfile.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)[]> @@ -664,13 +650,13 @@ Promise<[ShippingProfile](ShippingProfile.mdx)[]> ___ -### removeProducts +#### removeProducts `**removeProducts**(profileId, productId): Promise<void \| [ShippingProfile](ShippingProfile.mdx)>` Removes a product or an array of products from the profile. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [ShippingProfile](ShippingProfile.mdx)> @@ -711,14 +697,14 @@ Promise<void \| [ShippingProfile](ShippingProfile.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(profileId, options?): Promise<[ShippingProfile](ShippingProfile.mdx)>` Gets a profile by id. Throws in case of DB Error and if profile was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -759,11 +745,11 @@ Promise<[ShippingProfile](ShippingProfile.mdx)> ___ -### retrieveDefault +#### retrieveDefault `**retrieveDefault**(): Promise<null \| [ShippingProfile](ShippingProfile.mdx)>` -#### Returns +##### Returns Promise<null \| [ShippingProfile](ShippingProfile.mdx)> @@ -781,11 +767,11 @@ Promise<null \| [ShippingProfile](ShippingProfile.mdx)> ___ -### retrieveForProducts +#### retrieveForProducts `**retrieveForProducts**(productIds): Promise<{ [product_id: string]: [ShippingProfile](ShippingProfile.mdx)[]; }>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ [product_id: string]: [ShippingProfile](ShippingProfile.mdx)[]; }> @@ -817,13 +803,13 @@ Promise<{ [product_id: string]: [ShippingProfile](ShippingProfile.mdx)[ ___ -### retrieveGiftCardDefault +#### retrieveGiftCardDefault `**retrieveGiftCardDefault**(): Promise<null \| [ShippingProfile](ShippingProfile.mdx)>` Retrieves the default gift card profile -#### Returns +##### Returns Promise<null \| [ShippingProfile](ShippingProfile.mdx)> @@ -841,11 +827,11 @@ Promise<null \| [ShippingProfile](ShippingProfile.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -877,7 +863,7 @@ ___ ___ -### update +#### update `**update**(profileId, update): Promise<[ShippingProfile](ShippingProfile.mdx)>` @@ -885,7 +871,7 @@ Updates a profile. Metadata updates and product updates should use dedicated methods, e.g. `setMetadata`, `addProduct`, etc. The function will throw errors if metadata or product updates are attempted. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingProfile](ShippingProfile.mdx)> @@ -926,11 +912,11 @@ Promise<[ShippingProfile](ShippingProfile.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ShippingProfileService](ShippingProfileService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ShippingProfileService](ShippingProfileService.mdx) diff --git a/www/apps/docs/content/references/services/classes/ShippingTaxRate.mdx b/www/apps/docs/content/references/services/classes/ShippingTaxRate.mdx index c026a2759e..fb1e7b8cfa 100644 --- a/www/apps/docs/content/references/services/classes/ShippingTaxRate.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingTaxRate.mdx @@ -10,7 +10,7 @@ This represents the tax rates applied on a shipping option. ## Constructors -### constructor +#### constructor `**new ShippingTaxRate**()` diff --git a/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx b/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx index 336f5a13a4..364e4b5752 100644 --- a/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx +++ b/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx @@ -10,7 +10,7 @@ Base abstract entity for all entities ## Constructors -### constructor +#### constructor `**new SoftDeletableEntity**()` diff --git a/www/apps/docs/content/references/services/classes/StagedJob.mdx b/www/apps/docs/content/references/services/classes/StagedJob.mdx index a61087b684..316c4caea6 100644 --- a/www/apps/docs/content/references/services/classes/StagedJob.mdx +++ b/www/apps/docs/content/references/services/classes/StagedJob.mdx @@ -10,7 +10,7 @@ A staged job resource ## Constructors -### constructor +#### constructor `**new StagedJob**()` @@ -59,11 +59,11 @@ A staged job resource ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/StagedJobService.mdx b/www/apps/docs/content/references/services/classes/StagedJobService.mdx index 77463aecf6..0b0cc482c9 100644 --- a/www/apps/docs/content/references/services/classes/StagedJobService.mdx +++ b/www/apps/docs/content/references/services/classes/StagedJobService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate users. ## Constructors -### constructor +#### constructor `**new StagedJobService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -119,6 +103,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -190,11 +176,11 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[StagedJob](StagedJob.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[StagedJob](StagedJob.mdx)[]> @@ -226,11 +212,11 @@ Promise<[StagedJob](StagedJob.mdx)[]> ___ -### delete +#### delete `**delete**(stagedJobIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -262,11 +248,11 @@ Promise<void> ___ -### list +#### list `**list**(config): Promise<[StagedJob](StagedJob.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[StagedJob](StagedJob.mdx)[]> @@ -298,11 +284,11 @@ Promise<[StagedJob](StagedJob.mdx)[]> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -334,11 +320,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [StagedJobService](StagedJobService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [StagedJobService](StagedJobService.mdx) diff --git a/www/apps/docs/content/references/services/classes/Store.mdx b/www/apps/docs/content/references/services/classes/Store.mdx index 88824504e9..97014d0792 100644 --- a/www/apps/docs/content/references/services/classes/Store.mdx +++ b/www/apps/docs/content/references/services/classes/Store.mdx @@ -10,7 +10,7 @@ A store holds the main settings of the commerce shop. By default, only one store ## Constructors -### constructor +#### constructor `**new Store**()` @@ -149,11 +149,11 @@ A store holds the main settings of the commerce shop. By default, only one store ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/StorePostCustomersCustomerAddressesAddressReq.mdx b/www/apps/docs/content/references/services/classes/StorePostCustomersCustomerAddressesAddressReq.mdx index 0a8aecccfc..98bec87c7a 100644 --- a/www/apps/docs/content/references/services/classes/StorePostCustomersCustomerAddressesAddressReq.mdx +++ b/www/apps/docs/content/references/services/classes/StorePostCustomersCustomerAddressesAddressReq.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new StorePostCustomersCustomerAddressesAddressReq**()` diff --git a/www/apps/docs/content/references/services/classes/StoreService.mdx b/www/apps/docs/content/references/services/classes/StoreService.mdx index bf90a053a9..a375cf08c4 100644 --- a/www/apps/docs/content/references/services/classes/StoreService.mdx +++ b/www/apps/docs/content/references/services/classes/StoreService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate store settings. ## Constructors -### constructor +#### constructor `**new StoreService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addCurrency +#### addCurrency `**addCurrency**(code): Promise<[Store](Store.mdx)>` Add a currency to the store -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Store](Store.mdx)> @@ -167,7 +151,7 @@ Promise<[Store](Store.mdx)> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -175,6 +159,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -246,13 +232,13 @@ Promise<TResult> ___ -### create +#### create `**create**(): Promise<[Store](Store.mdx)>` Creates a store if it doesn't already exist. -#### Returns +##### Returns Promise<[Store](Store.mdx)> @@ -270,11 +256,11 @@ Promise<[Store](Store.mdx)> ___ -### getDefaultCurrency\_ +#### getDefaultCurrency\_ `Protected **getDefaultCurrency_**(code): [Partial](../types/Partial.mdx)<[Currency](Currency.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns [Partial](../types/Partial.mdx)<[Currency](Currency.mdx)> @@ -306,13 +292,13 @@ ___ ___ -### removeCurrency +#### removeCurrency `**removeCurrency**(code): Promise<any>` Removes a currency from the store -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<any> @@ -344,13 +330,13 @@ Promise<any> ___ -### retrieve +#### retrieve `**retrieve**(config?): Promise<[Store](Store.mdx)>` Retrieve the store settings. There is always a maximum of one store. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Store](Store.mdx)> @@ -382,11 +368,11 @@ Promise<[Store](Store.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -418,13 +404,13 @@ ___ ___ -### update +#### update `**update**(data): Promise<[Store](Store.mdx)>` Updates a store -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Store](Store.mdx)> @@ -456,11 +442,11 @@ Promise<[Store](Store.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [StoreService](StoreService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [StoreService](StoreService.mdx) diff --git a/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx b/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx index c61ec34a95..62e944ad0f 100644 --- a/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx +++ b/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new StrategyResolverService**(container)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -117,6 +101,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -188,11 +174,11 @@ Promise<TResult> ___ -### resolveBatchJobByType +#### resolveBatchJobByType `**resolveBatchJobByType**(type): [AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx) @@ -224,11 +210,11 @@ ___ ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -260,11 +246,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [StrategyResolverService](StrategyResolverService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [StrategyResolverService](StrategyResolverService.mdx) diff --git a/www/apps/docs/content/references/services/classes/StringComparisonOperator.mdx b/www/apps/docs/content/references/services/classes/StringComparisonOperator.mdx index 8e0609ba37..0d9c2a5a5c 100644 --- a/www/apps/docs/content/references/services/classes/StringComparisonOperator.mdx +++ b/www/apps/docs/content/references/services/classes/StringComparisonOperator.mdx @@ -10,7 +10,7 @@ Fields used to apply flexible filters on strings. ## Constructors -### constructor +#### constructor `**new StringComparisonOperator**()` diff --git a/www/apps/docs/content/references/services/classes/Swap.mdx b/www/apps/docs/content/references/services/classes/Swap.mdx index 87bef51638..457567cc26 100644 --- a/www/apps/docs/content/references/services/classes/Swap.mdx +++ b/www/apps/docs/content/references/services/classes/Swap.mdx @@ -10,7 +10,7 @@ A swap can be created when a Customer wishes to exchange Products that they have ## Constructors -### constructor +#### constructor `**new Swap**()` @@ -239,11 +239,11 @@ A swap can be created when a Customer wishes to exchange Products that they have ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/SwapService.mdx b/www/apps/docs/content/references/services/classes/SwapService.mdx index 094c2ef11c..f9e3bd4447 100644 --- a/www/apps/docs/content/references/services/classes/SwapService.mdx +++ b/www/apps/docs/content/references/services/classes/SwapService.mdx @@ -10,11 +10,11 @@ Handles swaps ## Constructors -### constructor +#### constructor `**new SwapService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### areReturnItemsValid +#### areReturnItemsValid `Protected **areReturnItemsValid**(returnItems): Promise<boolean>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -345,7 +329,7 @@ Promise<boolean> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -353,6 +337,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -424,7 +410,7 @@ Promise<TResult> ___ -### cancel +#### cancel `**cancel**(swapId): Promise<[Swap](Swap.mdx)>` @@ -432,7 +418,7 @@ Cancels a given swap if possible. A swap can only be canceled if all related returns, fulfillments, and payments have been canceled. If a swap is associated with a refund, it cannot be canceled. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -464,13 +450,13 @@ Promise<[Swap](Swap.mdx)> ___ -### cancelFulfillment +#### cancelFulfillment `**cancelFulfillment**(fulfillmentId): Promise<[Swap](Swap.mdx)>` Cancels a fulfillment (if related to a swap) -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -502,14 +488,14 @@ Promise<[Swap](Swap.mdx)> ___ -### create +#### create `**create**(order, returnItems, additionalItems?, returnShipping?, custom?): Promise<[Swap](Swap.mdx)>` Creates a swap from an order, with given return items, additional items and an optional return shipping method. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -631,7 +617,7 @@ Promise<[Swap](Swap.mdx)> ___ -### createCart +#### createCart `**createCart**(swapId, customShippingOptions?, context?): Promise<[Swap](Swap.mdx)>` @@ -640,7 +626,7 @@ for differences associated with the swap. The swap represented by the swapId must belong to the order. Fails if there is already a cart on the swap. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -699,14 +685,14 @@ Promise<[Swap](Swap.mdx)> ___ -### createFulfillment +#### createFulfillment `**createFulfillment**(swapId, config?): Promise<[Swap](Swap.mdx)>` Fulfills the additional items associated with the swap. Will call the fulfillment providers associated with the shipping methods. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -747,13 +733,13 @@ Promise<[Swap](Swap.mdx)> ___ -### createShipment +#### createShipment `**createShipment**(swapId, fulfillmentId, trackingLinks?, config?): Promise<[Swap](Swap.mdx)>` Marks a fulfillment as shipped and attaches tracking numbers. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -812,13 +798,13 @@ Promise<[Swap](Swap.mdx)> ___ -### deleteMetadata +#### deleteMetadata `**deleteMetadata**(swapId, key): Promise<[Swap](Swap.mdx)>` Dedicated method to delete metadata for a swap. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -859,13 +845,13 @@ Promise<[Swap](Swap.mdx)> ___ -### list +#### list `**list**(selector, config?): Promise<[Swap](Swap.mdx)[]>` List swaps. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)[]> @@ -906,13 +892,13 @@ Promise<[Swap](Swap.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[Swap](Swap.mdx)[], number]>` List swaps. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[Swap](Swap.mdx)[], number]> @@ -953,13 +939,13 @@ Promise<[[Swap](Swap.mdx)[], number]> ___ -### processDifference +#### processDifference `**processDifference**(swapId): Promise<[Swap](Swap.mdx)>` Process difference for the requested swap. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -991,13 +977,13 @@ Promise<[Swap](Swap.mdx)> ___ -### registerCartCompletion +#### registerCartCompletion `**registerCartCompletion**(swapId): Promise<[Swap](Swap.mdx)>` Register a cart completion -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -1029,14 +1015,14 @@ Promise<[Swap](Swap.mdx)> ___ -### registerReceived +#### registerReceived `**registerReceived**(id): Promise<[Swap](Swap.mdx)>` Registers the swap return items as received so that they cannot be used as a part of other swaps/returns. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -1068,13 +1054,13 @@ Promise<[Swap](Swap.mdx)> ___ -### retrieve +#### retrieve `**retrieve**(swapId, config?): Promise<[Swap](Swap.mdx)>` Retrieves a swap with the given id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -1115,13 +1101,13 @@ Promise<[Swap](Swap.mdx)> ___ -### retrieveByCartId +#### retrieveByCartId `**retrieveByCartId**(cartId, relations?): Promise<[Swap](Swap.mdx)>` Retrieves a swap based on its associated cart id -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -1162,11 +1148,11 @@ Promise<[Swap](Swap.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1198,13 +1184,13 @@ ___ ___ -### transformQueryForCart +#### transformQueryForCart `Protected **transformQueryForCart**(config): [Omit](../types/Omit.mdx)<[FindConfig](../interfaces/FindConfig.mdx)<[Swap](Swap.mdx)>, "select"> & { select?: string[] } & { cartRelations: undefined \| string[] ; cartSelects: undefined \| keyof [Cart](Cart.mdx)[] }` Transform find config object for retrieval. -#### Parameters +##### Parameters -#### Returns +##### Returns [Omit](../types/Omit.mdx)<[FindConfig](../interfaces/FindConfig.mdx)<[Swap](Swap.mdx)>, "select"> & ``{ select?: string[] }`` & ``{ cartRelations: undefined \| string[] ; cartSelects: undefined \| keyof [Cart](Cart.mdx)[] }`` @@ -1236,13 +1222,13 @@ Transform find config object for retrieval. ___ -### update +#### update `**update**(swapId, update): Promise<[Swap](Swap.mdx)>` Update the swap record. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[Swap](Swap.mdx)> @@ -1283,11 +1269,11 @@ Promise<[Swap](Swap.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [SwapService](SwapService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [SwapService](SwapService.mdx) diff --git a/www/apps/docs/content/references/services/classes/SystemPaymentProviderService.mdx b/www/apps/docs/content/references/services/classes/SystemPaymentProviderService.mdx index 6250de735b..ba1f5d0167 100644 --- a/www/apps/docs/content/references/services/classes/SystemPaymentProviderService.mdx +++ b/www/apps/docs/content/references/services/classes/SystemPaymentProviderService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new SystemPaymentProviderService**(_)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -117,6 +101,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -188,11 +174,11 @@ Promise<TResult> ___ -### authorizePayment +#### authorizePayment `**authorizePayment**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -224,11 +210,11 @@ Promise<Record<string, unknown>> ___ -### cancelPayment +#### cancelPayment `**cancelPayment**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -260,11 +246,11 @@ Promise<Record<string, unknown>> ___ -### capturePayment +#### capturePayment `**capturePayment**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -296,11 +282,11 @@ Promise<Record<string, unknown>> ___ -### createPayment +#### createPayment `**createPayment**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -332,11 +318,11 @@ Promise<Record<string, unknown>> ___ -### deletePayment +#### deletePayment `**deletePayment**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -368,11 +354,11 @@ Promise<Record<string, unknown>> ___ -### getPaymentData +#### getPaymentData `**getPaymentData**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -404,11 +390,11 @@ Promise<Record<string, unknown>> ___ -### getStatus +#### getStatus `**getStatus**(_): Promise<string>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string> @@ -440,11 +426,11 @@ Promise<string> ___ -### refundPayment +#### refundPayment `**refundPayment**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -476,11 +462,11 @@ Promise<Record<string, unknown>> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -512,11 +498,11 @@ ___ ___ -### updatePayment +#### updatePayment `**updatePayment**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -548,11 +534,11 @@ Promise<Record<string, unknown>> ___ -### updatePaymentData +#### updatePaymentData `**updatePaymentData**(_): Promise<Record<string, unknown>>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown>> @@ -584,11 +570,11 @@ Promise<Record<string, unknown>> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [SystemPaymentProviderService](SystemPaymentProviderService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [SystemPaymentProviderService](SystemPaymentProviderService.mdx) diff --git a/www/apps/docs/content/references/services/classes/TaxLine.mdx b/www/apps/docs/content/references/services/classes/TaxLine.mdx index dbeea4ee44..7970b000e8 100644 --- a/www/apps/docs/content/references/services/classes/TaxLine.mdx +++ b/www/apps/docs/content/references/services/classes/TaxLine.mdx @@ -10,7 +10,7 @@ A tax line represents the taxes amount applied to a line item. ## Constructors -### constructor +#### constructor `**new TaxLine**()` diff --git a/www/apps/docs/content/references/services/classes/TaxProvider.mdx b/www/apps/docs/content/references/services/classes/TaxProvider.mdx index 1c2b0faa98..c561d538c7 100644 --- a/www/apps/docs/content/references/services/classes/TaxProvider.mdx +++ b/www/apps/docs/content/references/services/classes/TaxProvider.mdx @@ -10,7 +10,7 @@ A tax provider represents a tax service installed in the Medusa backend, either ## Constructors -### constructor +#### constructor `**new TaxProvider**()` diff --git a/www/apps/docs/content/references/services/classes/TaxProviderService.mdx b/www/apps/docs/content/references/services/classes/TaxProviderService.mdx index 1a7826daf0..92a8ca49c4 100644 --- a/www/apps/docs/content/references/services/classes/TaxProviderService.mdx +++ b/www/apps/docs/content/references/services/classes/TaxProviderService.mdx @@ -10,11 +10,11 @@ Finds tax providers and assists in tax related operations. ## Constructors -### constructor +#### constructor `**new TaxProviderService**(container)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -173,6 +157,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -244,11 +230,11 @@ Promise<TResult> ___ -### clearLineItemsTaxLines +#### clearLineItemsTaxLines `**clearLineItemsTaxLines**(itemIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -280,11 +266,11 @@ Promise<void> ___ -### clearTaxLines +#### clearTaxLines `**clearTaxLines**(cartId): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -316,14 +302,14 @@ Promise<void> ___ -### createShippingTaxLines +#### createShippingTaxLines `**createShippingTaxLines**(shippingMethod, calculationContext): Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>` Persists the tax lines relevant for a shipping method to the database. Used for return shipping methods. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]> @@ -364,13 +350,13 @@ Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](S ___ -### createTaxLines +#### createTaxLines `**createTaxLines**(cartOrLineItems, calculationContext): Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>` Persists the tax lines relevant for an order to the database. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]> @@ -411,13 +397,13 @@ Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](S ___ -### getCacheKey +#### getCacheKey `Private **getCacheKey**(id, regionId): string` The cache key to get cache hits by. -#### Parameters +##### Parameters -#### Returns +##### Returns `string` @@ -458,14 +444,14 @@ The cache key to get cache hits by. ___ -### getRegionRatesForProduct +#### getRegionRatesForProduct `**getRegionRatesForProduct**(productIds, region): Promise<Map<string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]>>` Gets the tax rates configured for a product. The rates are cached between calls. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Map<string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]>> @@ -506,14 +492,14 @@ Promise<Map<string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]> ___ -### getRegionRatesForShipping +#### getRegionRatesForShipping `**getRegionRatesForShipping**(optionId, regionDetails): Promise<[TaxServiceRate](../types/TaxServiceRate.mdx)[]>` Gets the tax rates configured for a shipping option. The rates are cached between calls. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxServiceRate](../types/TaxServiceRate.mdx)[]> @@ -554,7 +540,7 @@ Promise<[TaxServiceRate](../types/TaxServiceRate.mdx)[]> ___ -### getShippingTaxLines +#### getShippingTaxLines `**getShippingTaxLines**(shippingMethod, calculationContext): Promise<[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]>` @@ -562,7 +548,7 @@ Gets the relevant tax lines for a shipping method. Note: this method doesn't persist the tax lines. Use createShippingTaxLines if you wish to persist the tax lines to the DB layer. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]> @@ -603,7 +589,7 @@ Promise<[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]> ___ -### getTaxLines +#### getTaxLines `**getTaxLines**(lineItems, calculationContext): Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>` @@ -613,7 +599,7 @@ will be computed from the tax rules and potentially a 3rd party tax plugin. Note: this method doesn't persist the tax lines. Use createTaxLines if you wish to persist the tax lines to the DB layer. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]> @@ -654,13 +640,13 @@ Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](S ___ -### getTaxLinesMap +#### getTaxLinesMap `Protected **getTaxLinesMap**(items, calculationContext): Promise<[TaxLinesMaps](../types/TaxLinesMaps.mdx)>` Return a map of tax lines for line items and shipping methods -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxLinesMaps](../types/TaxLinesMaps.mdx)> @@ -701,11 +687,11 @@ Promise<[TaxLinesMaps](../types/TaxLinesMaps.mdx)> ___ -### list +#### list `**list**(): Promise<[TaxProvider](TaxProvider.mdx)[]>` -#### Returns +##### Returns Promise<[TaxProvider](TaxProvider.mdx)[]> @@ -723,11 +709,11 @@ Promise<[TaxProvider](TaxProvider.mdx)[]> ___ -### registerInstalledProviders +#### registerInstalledProviders `**registerInstalledProviders**(providers): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -759,13 +745,13 @@ Promise<void> ___ -### retrieveProvider +#### retrieveProvider `**retrieveProvider**(region): [ITaxService](../interfaces/ITaxService.mdx)` Retrieves the relevant tax provider for the given region. -#### Parameters +##### Parameters -#### Returns +##### Returns [ITaxService](../interfaces/ITaxService.mdx) @@ -797,11 +783,11 @@ Retrieves the relevant tax provider for the given region. ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -833,11 +819,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [TaxProviderService](TaxProviderService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [TaxProviderService](TaxProviderService.mdx) diff --git a/www/apps/docs/content/references/services/classes/TaxRate.mdx b/www/apps/docs/content/references/services/classes/TaxRate.mdx index 45344f68a4..bf66a75088 100644 --- a/www/apps/docs/content/references/services/classes/TaxRate.mdx +++ b/www/apps/docs/content/references/services/classes/TaxRate.mdx @@ -10,7 +10,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, ## Constructors -### constructor +#### constructor `**new TaxRate**()` @@ -158,11 +158,11 @@ A Tax Rate can be used to define a custom rate to charge on specified products, ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/TaxRateService.mdx b/www/apps/docs/content/references/services/classes/TaxRateService.mdx index 5701279f29..0b834cdbde 100644 --- a/www/apps/docs/content/references/services/classes/TaxRateService.mdx +++ b/www/apps/docs/content/references/services/classes/TaxRateService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new TaxRateService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### addToProduct +#### addToProduct `**addToProduct**(id, productIds, replace?): Promise<[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxRate.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxRate.mdx)[]> @@ -190,11 +174,11 @@ Promise<[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxR ___ -### addToProductType +#### addToProductType `**addToProductType**(id, productTypeIds, replace?): Promise<[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]> @@ -244,11 +228,11 @@ Promise<[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]> ___ -### addToShippingOption +#### addToShippingOption `**addToShippingOption**(id, optionIds, replace?): Promise<[ShippingTaxRate](ShippingTaxRate.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingTaxRate](ShippingTaxRate.mdx)[]> @@ -298,7 +282,7 @@ Promise<[ShippingTaxRate](ShippingTaxRate.mdx)[]> ___ -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -306,6 +290,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -377,11 +363,11 @@ Promise<TResult> ___ -### create +#### create `**create**(data): Promise<[TaxRate](TaxRate.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxRate](TaxRate.mdx)> @@ -413,11 +399,11 @@ Promise<[TaxRate](TaxRate.mdx)> ___ -### delete +#### delete `**delete**(id): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -449,11 +435,11 @@ Promise<void> ___ -### list +#### list `**list**(selector, config?): Promise<[TaxRate](TaxRate.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxRate](TaxRate.mdx)[]> @@ -494,11 +480,11 @@ Promise<[TaxRate](TaxRate.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?): Promise<[[TaxRate](TaxRate.mdx)[], number]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[TaxRate](TaxRate.mdx)[], number]> @@ -539,11 +525,11 @@ Promise<[[TaxRate](TaxRate.mdx)[], number]> ___ -### listByProduct +#### listByProduct `**listByProduct**(productId, config): Promise<[TaxRate](TaxRate.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxRate](TaxRate.mdx)[]> @@ -584,11 +570,11 @@ Promise<[TaxRate](TaxRate.mdx)[]> ___ -### listByShippingOption +#### listByShippingOption `**listByShippingOption**(shippingOptionId): Promise<[TaxRate](TaxRate.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxRate](TaxRate.mdx)[]> @@ -620,11 +606,11 @@ Promise<[TaxRate](TaxRate.mdx)[]> ___ -### removeFromProduct +#### removeFromProduct `**removeFromProduct**(id, productIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -665,11 +651,11 @@ Promise<void> ___ -### removeFromProductType +#### removeFromProductType `**removeFromProductType**(id, typeIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -710,11 +696,11 @@ Promise<void> ___ -### removeFromShippingOption +#### removeFromShippingOption `**removeFromShippingOption**(id, optionIds): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -755,11 +741,11 @@ Promise<void> ___ -### retrieve +#### retrieve `**retrieve**(taxRateId, config?): Promise<[TaxRate](TaxRate.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxRate](TaxRate.mdx)> @@ -800,11 +786,11 @@ Promise<[TaxRate](TaxRate.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -836,11 +822,11 @@ ___ ___ -### update +#### update `**update**(id, data): Promise<[TaxRate](TaxRate.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxRate](TaxRate.mdx)> @@ -881,11 +867,11 @@ Promise<[TaxRate](TaxRate.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [TaxRateService](TaxRateService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [TaxRateService](TaxRateService.mdx) diff --git a/www/apps/docs/content/references/services/classes/TokenService.mdx b/www/apps/docs/content/references/services/classes/TokenService.mdx index 637ad4bc69..e129e512e6 100644 --- a/www/apps/docs/content/references/services/classes/TokenService.mdx +++ b/www/apps/docs/content/references/services/classes/TokenService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new TokenService**(«destructured»)` -#### Parameters +##### Parameters -#### Returns +##### Returns `string` @@ -96,11 +96,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ___ -### verifyToken +#### verifyToken `**verifyToken**(token, options?): string \| Jwt \| JwtPayload` -#### Parameters +##### Parameters -#### Returns +##### Returns `string` \| `Jwt` \| `JwtPayload` diff --git a/www/apps/docs/content/references/services/classes/TotalsService.mdx b/www/apps/docs/content/references/services/classes/TotalsService.mdx index 836950ebff..73d0370380 100644 --- a/www/apps/docs/content/references/services/classes/TotalsService.mdx +++ b/www/apps/docs/content/references/services/classes/TotalsService.mdx @@ -12,11 +12,11 @@ A service that calculates total and subtotals for orders, carts etc.. ## Constructors -### constructor +#### constructor `**new TotalsService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -148,6 +132,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -219,13 +205,13 @@ Promise<TResult> ___ -### calculateDiscount\_ +#### calculateDiscount\_ `**calculateDiscount_**(lineItem, variant, variantPrice, value, discountType): [LineDiscount](../types/LineDiscount.mdx)` Calculates either fixed or percentage discount of a variant -#### Parameters +##### Parameters -#### Returns +##### Returns [LineDiscount](../types/LineDiscount.mdx) @@ -297,7 +283,7 @@ Calculates either fixed or percentage discount of a variant ___ -### getAllocationItemDiscounts +#### getAllocationItemDiscounts `**getAllocationItemDiscounts**(discount, cart): [LineDiscount](../types/LineDiscount.mdx)[]` @@ -307,7 +293,7 @@ make sure to only apply the discount on valid variants. And finally we return ether an array of percentages discounts or fixed discounts alongside the variant on which the discount was applied. -#### Parameters +##### Parameters -#### Returns +##### Returns [LineDiscount](../types/LineDiscount.mdx)[] @@ -348,7 +334,7 @@ alongside the variant on which the discount was applied. ___ -### getAllocationMap +#### getAllocationMap `**getAllocationMap**(orderOrCart, options?): Promise<[LineAllocationsMap](../types/LineAllocationsMap.mdx)>` @@ -356,7 +342,7 @@ Gets a map of discounts and gift cards that apply to line items in an order. The function calculates the amount of a discount or gift card that applies to a specific line item. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineAllocationsMap](../types/LineAllocationsMap.mdx)> @@ -433,13 +419,13 @@ Promise<[LineAllocationsMap](../types/LineAllocationsMap.mdx)> ___ -### getCalculationContext +#### getCalculationContext `**getCalculationContext**(calculationContextData, options?): Promise<[TaxCalculationContext](../types/TaxCalculationContext.mdx)>` Prepares the calculation context for a tax total calculation. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[TaxCalculationContext](../types/TaxCalculationContext.mdx)> @@ -480,14 +466,14 @@ Promise<[TaxCalculationContext](../types/TaxCalculationContext.mdx)> ___ -### getDiscountTotal +#### getDiscountTotal `**getDiscountTotal**(cartOrOrder): Promise<number>` Calculates the total discount amount for each of the different supported discount types. If discounts aren't present or invalid returns 0. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -519,13 +505,13 @@ Promise<number> ___ -### getGiftCardTotal +#### getGiftCardTotal `**getGiftCardTotal**(cartOrOrder, opts?): Promise<{ tax_total: number ; total: number }>` Gets the gift card amount on a cart or order. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<{ tax_total: number ; total: number }> @@ -575,14 +561,14 @@ Promise<{ tax_total: number ; total: number }> ___ -### getGiftCardableAmount +#### getGiftCardableAmount `**getGiftCardableAmount**(cartOrOrder): Promise<number>` Gets the amount that can be gift carded on a cart. In regions where gift cards are taxable this amount should exclude taxes. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -614,13 +600,13 @@ Promise<number> ___ -### getLineDiscounts +#### getLineDiscounts `**getLineDiscounts**(cartOrOrder, discount?): [LineDiscountAmount](../types/LineDiscountAmount.mdx)[]` Returns the discount amount allocated to the line items of an order. -#### Parameters +##### Parameters -#### Returns +##### Returns [LineDiscountAmount](../types/LineDiscountAmount.mdx)[] @@ -688,11 +674,11 @@ Returns the discount amount allocated to the line items of an order. ___ -### getLineItemAdjustmentsTotal +#### getLineItemAdjustmentsTotal `**getLineItemAdjustmentsTotal**(cartOrOrder): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -724,11 +710,11 @@ ___ ___ -### getLineItemDiscountAdjustment +#### getLineItemDiscountAdjustment `**getLineItemDiscountAdjustment**(lineItem, discount): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -769,13 +755,13 @@ ___ ___ -### getLineItemRefund +#### getLineItemRefund `**getLineItemRefund**(order, lineItem): Promise<number>` The amount that can be refunded for a given line item. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -816,14 +802,14 @@ Promise<number> ___ -### getLineItemTotal +#### getLineItemTotal `**getLineItemTotal**(lineItem, cartOrOrder, options?): Promise<number>` Gets a total for a line item. The total can take gift cards, discounts and taxes into account. This can be controlled through the options. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -873,7 +859,7 @@ Promise<number> ___ -### getLineItemTotals +#### getLineItemTotals `**getLineItemTotals**(lineItem, cartOrOrder, options?): Promise<[LineItemTotals](../types/LineItemTotals-1.mdx)>` @@ -881,7 +867,7 @@ Breaks down the totals related to a line item; these are the subtotal, the amount of discount applied to the line item, the amount of a gift card applied to a line item and the amount of tax applied to a line item. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[LineItemTotals](../types/LineItemTotals-1.mdx)> @@ -931,13 +917,13 @@ Promise<[LineItemTotals](../types/LineItemTotals-1.mdx)> ___ -### getPaidTotal +#### getPaidTotal `**getPaidTotal**(order): number` Gets the total payments made on an order -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -969,7 +955,7 @@ Gets the total payments made on an order ___ -### getRefundTotal +#### getRefundTotal `**getRefundTotal**(order, lineItems): Promise<number>` @@ -977,7 +963,7 @@ Calculates refund total of line items. If any of the items to return have been discounted, we need to apply the discount again before refunding them. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1018,13 +1004,13 @@ Promise<number> ___ -### getRefundedTotal +#### getRefundedTotal `**getRefundedTotal**(order): number` Gets the total refund amount for an order. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1056,14 +1042,14 @@ Gets the total refund amount for an order. ___ -### getShippingMethodTotals +#### getShippingMethodTotals `**getShippingMethodTotals**(shippingMethod, cartOrOrder, opts?): Promise<[ShippingMethodTotals](../types/ShippingMethodTotals-1.mdx)>` Gets the totals breakdown for a shipping method. Fetches tax lines if not already provided. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ShippingMethodTotals](../types/ShippingMethodTotals-1.mdx)> @@ -1113,13 +1099,13 @@ Promise<[ShippingMethodTotals](../types/ShippingMethodTotals-1.mdx)> ___ -### getShippingTotal +#### getShippingTotal `**getShippingTotal**(cartOrOrder): Promise<number>` Calculates shipping total -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1151,13 +1137,13 @@ Promise<number> ___ -### getSubtotal +#### getSubtotal `**getSubtotal**(cartOrOrder, opts?): Promise<number>` Calculates subtotal of a given cart or order. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1198,14 +1184,14 @@ Promise<number> ___ -### getSwapTotal +#### getSwapTotal `**getSwapTotal**(order): number` The total paid for swaps. May be negative in case of negative swap difference. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1237,14 +1223,14 @@ difference. ___ -### getTaxTotal +#### getTaxTotal `**getTaxTotal**(cartOrOrder, forceTaxes?): Promise<null \| number>` Calculates tax total Currently based on the Danish tax system -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<null \| number> @@ -1285,13 +1271,13 @@ Promise<null \| number> ___ -### getTotal +#### getTotal `**getTotal**(cartOrOrder, options?): Promise<number>` Calculates total of a given cart or order. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1332,13 +1318,13 @@ Promise<number> ___ -### rounded +#### rounded `**rounded**(value): number` Rounds a number using Math.round. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1370,11 +1356,11 @@ Rounds a number using Math.round. ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1406,11 +1392,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [TotalsService](TotalsService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [TotalsService](TotalsService.mdx) diff --git a/www/apps/docs/content/references/services/classes/TrackingLink.mdx b/www/apps/docs/content/references/services/classes/TrackingLink.mdx index 15d2b639d1..56b8f3ca60 100644 --- a/www/apps/docs/content/references/services/classes/TrackingLink.mdx +++ b/www/apps/docs/content/references/services/classes/TrackingLink.mdx @@ -10,7 +10,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac ## Constructors -### constructor +#### constructor `**new TrackingLink**()` @@ -113,11 +113,11 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx b/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx index b38ed2f874..a342a104e7 100644 --- a/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx +++ b/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `Protected **new TransactionBaseService**(__container__, __configModule__?, __moduleDeclaration__?)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -126,6 +110,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -197,11 +183,11 @@ Promise<TResult> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -233,11 +219,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [TransactionBaseService](TransactionBaseService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [TransactionBaseService](TransactionBaseService.mdx) diff --git a/www/apps/docs/content/references/services/classes/User.mdx b/www/apps/docs/content/references/services/classes/User.mdx index 1bd5b71b3e..f5df76fcd7 100644 --- a/www/apps/docs/content/references/services/classes/User.mdx +++ b/www/apps/docs/content/references/services/classes/User.mdx @@ -10,7 +10,7 @@ A User is an administrator who can manage store settings and data. ## Constructors -### constructor +#### constructor `**new User**()` @@ -122,11 +122,11 @@ A User is an administrator who can manage store settings and data. ## Methods -### beforeInsert +#### beforeInsert `Private **beforeInsert**(): void` -#### Returns +##### Returns `void` diff --git a/www/apps/docs/content/references/services/classes/UserService.mdx b/www/apps/docs/content/references/services/classes/UserService.mdx index fb72e0aed0..ae77b509ad 100644 --- a/www/apps/docs/content/references/services/classes/UserService.mdx +++ b/www/apps/docs/content/references/services/classes/UserService.mdx @@ -10,11 +10,11 @@ Provides layer to manipulate users. ## Constructors -### constructor +#### constructor `**new UserService**(«destructured»)` -#### Parameters +##### Parameters + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -191,6 +175,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -262,14 +248,14 @@ Promise<TResult> ___ -### create +#### create `**create**(user, password): Promise<[User](User.mdx)>` Creates a user with username being validated. Fails if email is not a valid format. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[User](User.mdx)> @@ -310,13 +296,13 @@ Promise<[User](User.mdx)> ___ -### delete +#### delete `**delete**(userId): Promise<void>` Deletes a user from a given user id. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -348,7 +334,7 @@ Promise<void> ___ -### generateResetPasswordToken +#### generateResetPasswordToken `**generateResetPasswordToken**(userId): Promise<string>` @@ -358,7 +344,7 @@ The token will be signed with the users current password hash as a secret a long side a payload with userId and the expiry time for the token, which is always 15 minutes. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string> @@ -390,13 +376,13 @@ Promise<string> ___ -### hashPassword\_ +#### hashPassword\_ `**hashPassword_**(password): Promise<string>` Hashes a password -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<string> @@ -428,11 +414,11 @@ Promise<string> ___ -### list +#### list `**list**(selector, config?): Promise<[User](User.mdx)[]>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[User](User.mdx)[]> @@ -473,14 +459,14 @@ Promise<[User](User.mdx)[]> ___ -### retrieve +#### retrieve `**retrieve**(userId, config?): Promise<[User](User.mdx)>` Gets a user by id. Throws in case of DB Error and if user was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[User](User.mdx)> @@ -521,14 +507,14 @@ Promise<[User](User.mdx)> ___ -### retrieveByApiToken +#### retrieveByApiToken `**retrieveByApiToken**(apiToken, relations?): Promise<[User](User.mdx)>` Gets a user by api token. Throws in case of DB Error and if user was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[User](User.mdx)> @@ -569,14 +555,14 @@ Promise<[User](User.mdx)> ___ -### retrieveByEmail +#### retrieveByEmail `**retrieveByEmail**(email, config?): Promise<[User](User.mdx)>` Gets a user by email. Throws in case of DB Error and if user was not found. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[User](User.mdx)> @@ -617,7 +603,7 @@ Promise<[User](User.mdx)> ___ -### setPassword\_ +#### setPassword\_ `**setPassword_**(userId, password): Promise<[User](User.mdx)>` @@ -625,7 +611,7 @@ Sets a password for a user Fails if no user exists with userId and if the hashing of the new password does not work. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[User](User.mdx)> @@ -666,11 +652,11 @@ Promise<[User](User.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -702,13 +688,13 @@ ___ ___ -### update +#### update `**update**(userId, update): Promise<[User](User.mdx)>` Updates a user. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[User](User.mdx)> @@ -749,11 +735,11 @@ Promise<[User](User.mdx)> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [UserService](UserService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [UserService](UserService.mdx) diff --git a/www/apps/docs/content/references/services/enums/AllocationType.mdx b/www/apps/docs/content/references/services/enums/AllocationType.mdx index fdfce12e50..c160009d4f 100644 --- a/www/apps/docs/content/references/services/enums/AllocationType.mdx +++ b/www/apps/docs/content/references/services/enums/AllocationType.mdx @@ -10,7 +10,7 @@ The scope that the discount should apply to. ## Enumeration Members -### ITEM +#### ITEM **ITEM** = `"item"` @@ -18,7 +18,7 @@ The discount should be applied to applicable items in the cart. ___ -### TOTAL +#### TOTAL **TOTAL** = `"total"` diff --git a/www/apps/docs/content/references/services/enums/BatchJobStatus.mdx b/www/apps/docs/content/references/services/enums/BatchJobStatus.mdx index 5293589f20..4f7314576a 100644 --- a/www/apps/docs/content/references/services/enums/BatchJobStatus.mdx +++ b/www/apps/docs/content/references/services/enums/BatchJobStatus.mdx @@ -8,42 +8,42 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` ___ -### COMPLETED +#### COMPLETED **COMPLETED** = `"completed"` ___ -### CONFIRMED +#### CONFIRMED **CONFIRMED** = `"confirmed"` ___ -### CREATED +#### CREATED **CREATED** = `"created"` ___ -### FAILED +#### FAILED **FAILED** = `"failed"` ___ -### PRE\_PROCESSED +#### PRE\_PROCESSED **PRE\_PROCESSED** = `"pre_processed"` ___ -### PROCESSING +#### PROCESSING **PROCESSING** = `"processing"` diff --git a/www/apps/docs/content/references/services/enums/CartType.mdx b/www/apps/docs/content/references/services/enums/CartType.mdx index 4240fcc2e2..0c83012487 100644 --- a/www/apps/docs/content/references/services/enums/CartType.mdx +++ b/www/apps/docs/content/references/services/enums/CartType.mdx @@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### CLAIM +#### CLAIM **CLAIM** = `"claim"` ___ -### DEFAULT +#### DEFAULT **DEFAULT** = `"default"` ___ -### DRAFT\_ORDER +#### DRAFT\_ORDER **DRAFT\_ORDER** = `"draft_order"` ___ -### PAYMENT\_LINK +#### PAYMENT\_LINK **PAYMENT\_LINK** = `"payment_link"` ___ -### SWAP +#### SWAP **SWAP** = `"swap"` diff --git a/www/apps/docs/content/references/services/enums/ClaimFulfillmentStatus.mdx b/www/apps/docs/content/references/services/enums/ClaimFulfillmentStatus.mdx index 1ab00b8e89..a0a5188589 100644 --- a/www/apps/docs/content/references/services/enums/ClaimFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/services/enums/ClaimFulfillmentStatus.mdx @@ -10,7 +10,7 @@ The claim's fulfillment status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The claim's fulfillments are canceled. ___ -### FULFILLED +#### FULFILLED **FULFILLED** = `"fulfilled"` @@ -26,7 +26,7 @@ The claim's replacement items are fulfilled. ___ -### NOT\_FULFILLED +#### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` @@ -34,7 +34,7 @@ The claim's replacement items are not fulfilled. ___ -### PARTIALLY\_FULFILLED +#### PARTIALLY\_FULFILLED **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` @@ -42,7 +42,7 @@ Some of the claim's replacement items, but not all, are fulfilled. ___ -### PARTIALLY\_RETURNED +#### PARTIALLY\_RETURNED **PARTIALLY\_RETURNED** = `"partially_returned"` @@ -50,7 +50,7 @@ Some of the claim's items, but not all, are returned. ___ -### PARTIALLY\_SHIPPED +#### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` @@ -58,7 +58,7 @@ Some of the claim's replacement items, but not all, are shipped. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` @@ -66,7 +66,7 @@ The claim's fulfillment requires action. ___ -### RETURNED +#### RETURNED **RETURNED** = `"returned"` @@ -74,7 +74,7 @@ The claim's items are returned. ___ -### SHIPPED +#### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/services/enums/ClaimPaymentStatus.mdx b/www/apps/docs/content/references/services/enums/ClaimPaymentStatus.mdx index e85fb0ed23..1942100811 100644 --- a/www/apps/docs/content/references/services/enums/ClaimPaymentStatus.mdx +++ b/www/apps/docs/content/references/services/enums/ClaimPaymentStatus.mdx @@ -10,7 +10,7 @@ The claim's payment status ## Enumeration Members -### NA +#### NA **NA** = `"na"` @@ -18,7 +18,7 @@ The payment status isn't set, which is typically used when the claim's type is ` ___ -### NOT\_REFUNDED +#### NOT\_REFUNDED **NOT\_REFUNDED** = `"not_refunded"` @@ -26,7 +26,7 @@ The payment isn't refunded. ___ -### REFUNDED +#### REFUNDED **REFUNDED** = `"refunded"` diff --git a/www/apps/docs/content/references/services/enums/ClaimReason.mdx b/www/apps/docs/content/references/services/enums/ClaimReason.mdx index 5dcd9213c1..94b28316d6 100644 --- a/www/apps/docs/content/references/services/enums/ClaimReason.mdx +++ b/www/apps/docs/content/references/services/enums/ClaimReason.mdx @@ -8,24 +8,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### MISSING\_ITEM +#### MISSING\_ITEM **MISSING\_ITEM** = `"missing_item"` ___ -### OTHER +#### OTHER **OTHER** = `"other"` ___ -### PRODUCTION\_FAILURE +#### PRODUCTION\_FAILURE **PRODUCTION\_FAILURE** = `"production_failure"` ___ -### WRONG\_ITEM +#### WRONG\_ITEM **WRONG\_ITEM** = `"wrong_item"` diff --git a/www/apps/docs/content/references/services/enums/ClaimType.mdx b/www/apps/docs/content/references/services/enums/ClaimType.mdx index 5790ef30ac..e1310bccbb 100644 --- a/www/apps/docs/content/references/services/enums/ClaimType.mdx +++ b/www/apps/docs/content/references/services/enums/ClaimType.mdx @@ -10,7 +10,7 @@ The claim's type. ## Enumeration Members -### REFUND +#### REFUND **REFUND** = `"refund"` @@ -18,7 +18,7 @@ The claim refunds an amount to the customer. ___ -### REPLACE +#### REPLACE **REPLACE** = `"replace"` diff --git a/www/apps/docs/content/references/services/enums/DefaultPriceType.mdx b/www/apps/docs/content/references/services/enums/DefaultPriceType.mdx index c2e46d6b88..792b0a0a69 100644 --- a/www/apps/docs/content/references/services/enums/DefaultPriceType.mdx +++ b/www/apps/docs/content/references/services/enums/DefaultPriceType.mdx @@ -8,6 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## References -### DEFAULT +#### DEFAULT -Re-exports [DEFAULT](../index.md#default) + **DEFAULT** = [object Object] diff --git a/www/apps/docs/content/references/services/enums/DiscountConditionJoinTableForeignKey.mdx b/www/apps/docs/content/references/services/enums/DiscountConditionJoinTableForeignKey.mdx index 5ffc89335a..dc1f07c524 100644 --- a/www/apps/docs/content/references/services/enums/DiscountConditionJoinTableForeignKey.mdx +++ b/www/apps/docs/content/references/services/enums/DiscountConditionJoinTableForeignKey.mdx @@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### CUSTOMER\_GROUP\_ID +#### CUSTOMER\_GROUP\_ID **CUSTOMER\_GROUP\_ID** = `"customer_group_id"` ___ -### PRODUCT\_COLLECTION\_ID +#### PRODUCT\_COLLECTION\_ID **PRODUCT\_COLLECTION\_ID** = `"product_collection_id"` ___ -### PRODUCT\_ID +#### PRODUCT\_ID **PRODUCT\_ID** = `"product_id"` ___ -### PRODUCT\_TAG\_ID +#### PRODUCT\_TAG\_ID **PRODUCT\_TAG\_ID** = `"product_tag_id"` ___ -### PRODUCT\_TYPE\_ID +#### PRODUCT\_TYPE\_ID **PRODUCT\_TYPE\_ID** = `"product_type_id"` diff --git a/www/apps/docs/content/references/services/enums/DiscountConditionOperator.mdx b/www/apps/docs/content/references/services/enums/DiscountConditionOperator.mdx index c31cac8daf..91aaa9ea49 100644 --- a/www/apps/docs/content/references/services/enums/DiscountConditionOperator.mdx +++ b/www/apps/docs/content/references/services/enums/DiscountConditionOperator.mdx @@ -10,7 +10,7 @@ The possible operators used for a discount condition. ## Enumeration Members -### IN +#### IN **IN** = `"in"` @@ -18,7 +18,7 @@ The discountable resources are within the specified resources. ___ -### NOT\_IN +#### NOT\_IN **NOT\_IN** = `"not_in"` diff --git a/www/apps/docs/content/references/services/enums/DiscountConditionType.mdx b/www/apps/docs/content/references/services/enums/DiscountConditionType.mdx index f9802294cf..78a706afec 100644 --- a/www/apps/docs/content/references/services/enums/DiscountConditionType.mdx +++ b/www/apps/docs/content/references/services/enums/DiscountConditionType.mdx @@ -10,7 +10,7 @@ The discount condition's type. ## Enumeration Members -### CUSTOMER\_GROUPS +#### CUSTOMER\_GROUPS **CUSTOMER\_GROUPS** = `"customer_groups"` @@ -18,7 +18,7 @@ The discount condition is used for customer groups. ___ -### PRODUCTS +#### PRODUCTS **PRODUCTS** = `"products"` @@ -26,7 +26,7 @@ The discount condition is used for products. ___ -### PRODUCT\_COLLECTIONS +#### PRODUCT\_COLLECTIONS **PRODUCT\_COLLECTIONS** = `"product_collections"` @@ -34,7 +34,7 @@ The discount condition is used for product collections. ___ -### PRODUCT\_TAGS +#### PRODUCT\_TAGS **PRODUCT\_TAGS** = `"product_tags"` @@ -42,7 +42,7 @@ The discount condition is used for product tags. ___ -### PRODUCT\_TYPES +#### PRODUCT\_TYPES **PRODUCT\_TYPES** = `"product_types"` diff --git a/www/apps/docs/content/references/services/enums/DiscountRuleType.mdx b/www/apps/docs/content/references/services/enums/DiscountRuleType.mdx index 1009bfff16..eb59f18776 100644 --- a/www/apps/docs/content/references/services/enums/DiscountRuleType.mdx +++ b/www/apps/docs/content/references/services/enums/DiscountRuleType.mdx @@ -10,7 +10,7 @@ The possible types of discount rules. ## Enumeration Members -### FIXED +#### FIXED **FIXED** = `"fixed"` @@ -18,7 +18,7 @@ Discounts that reduce the price by a fixed amount. ___ -### FREE\_SHIPPING +#### FREE\_SHIPPING **FREE\_SHIPPING** = `"free_shipping"` @@ -26,7 +26,7 @@ Discounts that sets the shipping price to `0`. ___ -### PERCENTAGE +#### PERCENTAGE **PERCENTAGE** = `"percentage"` diff --git a/www/apps/docs/content/references/services/enums/DraftOrderStatus.mdx b/www/apps/docs/content/references/services/enums/DraftOrderStatus.mdx index 8aa3c85e0e..0d9576c279 100644 --- a/www/apps/docs/content/references/services/enums/DraftOrderStatus.mdx +++ b/www/apps/docs/content/references/services/enums/DraftOrderStatus.mdx @@ -10,7 +10,7 @@ The draft order's status. ## Enumeration Members -### COMPLETED +#### COMPLETED **COMPLETED** = `"completed"` @@ -18,7 +18,7 @@ The draft order is completed, and an order has been created from it. ___ -### OPEN +#### OPEN **OPEN** = `"open"` diff --git a/www/apps/docs/content/references/services/enums/FulfillmentStatus-1.mdx b/www/apps/docs/content/references/services/enums/FulfillmentStatus-1.mdx index 505e9c140c..3e672a5140 100644 --- a/www/apps/docs/content/references/services/enums/FulfillmentStatus-1.mdx +++ b/www/apps/docs/content/references/services/enums/FulfillmentStatus-1.mdx @@ -10,7 +10,7 @@ The fulfillment status of an order. ## Enumeration Members -### canceled +#### canceled **canceled** = `"canceled"` @@ -18,7 +18,7 @@ The order's fulfillments are canceled. ___ -### fulfilled +#### fulfilled **fulfilled** = `"fulfilled"` @@ -26,7 +26,7 @@ All of the order's items are fulfilled. ___ -### not\_fulfilled +#### not\_fulfilled **not\_fulfilled** = `"not_fulfilled"` @@ -34,7 +34,7 @@ The order isn't fulfilled. ___ -### partially\_fulfilled +#### partially\_fulfilled **partially\_fulfilled** = `"partially_fulfilled"` @@ -42,7 +42,7 @@ Some, but not all, of the order's items are fulfilled. ___ -### partially\_returned +#### partially\_returned **partially\_returned** = `"partially_returned"` @@ -50,7 +50,7 @@ Some, but not all, of the order's items are returned. ___ -### partially\_shipped +#### partially\_shipped **partially\_shipped** = `"partially_shipped"` @@ -58,7 +58,7 @@ Some, but not all, of the order's items are shipped. ___ -### requires\_action +#### requires\_action **requires\_action** = `"requires_action"` @@ -66,7 +66,7 @@ The order's fulfillment requires an action. ___ -### returned +#### returned **returned** = `"returned"` @@ -74,7 +74,7 @@ All of the order's items are returned. ___ -### shipped +#### shipped **shipped** = `"shipped"` diff --git a/www/apps/docs/content/references/services/enums/FulfillmentStatus.mdx b/www/apps/docs/content/references/services/enums/FulfillmentStatus.mdx index f1214a65b6..c294ba1e4a 100644 --- a/www/apps/docs/content/references/services/enums/FulfillmentStatus.mdx +++ b/www/apps/docs/content/references/services/enums/FulfillmentStatus.mdx @@ -10,7 +10,7 @@ The order's fulfillment status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The order's fulfillments are canceled. ___ -### FULFILLED +#### FULFILLED **FULFILLED** = `"fulfilled"` @@ -26,7 +26,7 @@ The order's items are fulfilled. ___ -### NOT\_FULFILLED +#### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` @@ -34,7 +34,7 @@ The order's items are not fulfilled. ___ -### PARTIALLY\_FULFILLED +#### PARTIALLY\_FULFILLED **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` @@ -42,7 +42,7 @@ Some of the order's items, but not all, are fulfilled. ___ -### PARTIALLY\_RETURNED +#### PARTIALLY\_RETURNED **PARTIALLY\_RETURNED** = `"partially_returned"` @@ -50,7 +50,7 @@ Some of the order's items, but not all, are returned. ___ -### PARTIALLY\_SHIPPED +#### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` @@ -58,7 +58,7 @@ Some of the order's items, but not all, are shipped. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` @@ -66,7 +66,7 @@ The order's fulfillment requires action. ___ -### RETURNED +#### RETURNED **RETURNED** = `"returned"` @@ -74,7 +74,7 @@ The order's items are returned. ___ -### SHIPPED +#### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/services/enums/MODULE_RESOURCE_TYPE.mdx b/www/apps/docs/content/references/services/enums/MODULE_RESOURCE_TYPE.mdx index 5d352c5caa..8d95d8ec9b 100644 --- a/www/apps/docs/content/references/services/enums/MODULE_RESOURCE_TYPE.mdx +++ b/www/apps/docs/content/references/services/enums/MODULE_RESOURCE_TYPE.mdx @@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### ISOLATED +#### ISOLATED **ISOLATED** = `"isolated"` ___ -### SHARED +#### SHARED **SHARED** = `"shared"` diff --git a/www/apps/docs/content/references/services/enums/OrderEditItemChangeType.mdx b/www/apps/docs/content/references/services/enums/OrderEditItemChangeType.mdx index 56c095e085..5b527a2506 100644 --- a/www/apps/docs/content/references/services/enums/OrderEditItemChangeType.mdx +++ b/www/apps/docs/content/references/services/enums/OrderEditItemChangeType.mdx @@ -10,7 +10,7 @@ The type of the order edit item change. ## Enumeration Members -### ITEM\_ADD +#### ITEM\_ADD **ITEM\_ADD** = `"item_add"` @@ -18,7 +18,7 @@ A new item to be added to the original order. ___ -### ITEM\_REMOVE +#### ITEM\_REMOVE **ITEM\_REMOVE** = `"item_remove"` @@ -26,7 +26,7 @@ An existing item to be removed from the original order. ___ -### ITEM\_UPDATE +#### ITEM\_UPDATE **ITEM\_UPDATE** = `"item_update"` diff --git a/www/apps/docs/content/references/services/enums/OrderEditStatus.mdx b/www/apps/docs/content/references/services/enums/OrderEditStatus.mdx index df66c8b4b8..344e5a6c59 100644 --- a/www/apps/docs/content/references/services/enums/OrderEditStatus.mdx +++ b/www/apps/docs/content/references/services/enums/OrderEditStatus.mdx @@ -10,7 +10,7 @@ The order edit's status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The order edit is canceled. ___ -### CONFIRMED +#### CONFIRMED **CONFIRMED** = `"confirmed"` @@ -26,7 +26,7 @@ The order edit is confirmed. ___ -### CREATED +#### CREATED **CREATED** = `"created"` @@ -34,7 +34,7 @@ The order edit is created. ___ -### DECLINED +#### DECLINED **DECLINED** = `"declined"` @@ -42,7 +42,7 @@ The order edit is declined. ___ -### REQUESTED +#### REQUESTED **REQUESTED** = `"requested"` diff --git a/www/apps/docs/content/references/services/enums/OrderStatus-1.mdx b/www/apps/docs/content/references/services/enums/OrderStatus-1.mdx index 80bd4fd4d5..45cde25202 100644 --- a/www/apps/docs/content/references/services/enums/OrderStatus-1.mdx +++ b/www/apps/docs/content/references/services/enums/OrderStatus-1.mdx @@ -10,7 +10,7 @@ The status of an order. ## Enumeration Members -### archived +#### archived **archived** = `"archived"` @@ -18,7 +18,7 @@ Order is archived. ___ -### canceled +#### canceled **canceled** = `"canceled"` @@ -26,7 +26,7 @@ Order is canceled. ___ -### completed +#### completed **completed** = `"completed"` @@ -34,7 +34,7 @@ Order is completed. An order is completed when it's paid and fulfilled. ___ -### pending +#### pending **pending** = `"pending"` @@ -42,7 +42,7 @@ Order is pending. ___ -### requires\_action +#### requires\_action **requires\_action** = `"requires_action"` diff --git a/www/apps/docs/content/references/services/enums/OrderStatus.mdx b/www/apps/docs/content/references/services/enums/OrderStatus.mdx index cd0d5a795d..63f8f36ff7 100644 --- a/www/apps/docs/content/references/services/enums/OrderStatus.mdx +++ b/www/apps/docs/content/references/services/enums/OrderStatus.mdx @@ -10,7 +10,7 @@ The order's status. ## Enumeration Members -### ARCHIVED +#### ARCHIVED **ARCHIVED** = `"archived"` @@ -18,7 +18,7 @@ The order is archived. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -26,7 +26,7 @@ The order is canceled. ___ -### COMPLETED +#### COMPLETED **COMPLETED** = `"completed"` @@ -36,7 +36,7 @@ has been captured. ___ -### PENDING +#### PENDING **PENDING** = `"pending"` @@ -44,7 +44,7 @@ The order is pending. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/services/enums/PaymentCollectionStatus.mdx b/www/apps/docs/content/references/services/enums/PaymentCollectionStatus.mdx index 74bc707f72..de87c6ae0a 100644 --- a/www/apps/docs/content/references/services/enums/PaymentCollectionStatus.mdx +++ b/www/apps/docs/content/references/services/enums/PaymentCollectionStatus.mdx @@ -10,7 +10,7 @@ The payment collection's status. ## Enumeration Members -### AUTHORIZED +#### AUTHORIZED **AUTHORIZED** = `"authorized"` @@ -18,7 +18,7 @@ The payment colleciton is authorized. ___ -### AWAITING +#### AWAITING **AWAITING** = `"awaiting"` @@ -26,7 +26,7 @@ The payment collection is awaiting payment. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -34,7 +34,7 @@ The payment collection is canceled. ___ -### NOT\_PAID +#### NOT\_PAID **NOT\_PAID** = `"not_paid"` @@ -42,7 +42,7 @@ The payment collection isn't paid. ___ -### PARTIALLY\_AUTHORIZED +#### PARTIALLY\_AUTHORIZED **PARTIALLY\_AUTHORIZED** = `"partially_authorized"` diff --git a/www/apps/docs/content/references/services/enums/PaymentCollectionType.mdx b/www/apps/docs/content/references/services/enums/PaymentCollectionType.mdx index 5e7048569b..55a00e837a 100644 --- a/www/apps/docs/content/references/services/enums/PaymentCollectionType.mdx +++ b/www/apps/docs/content/references/services/enums/PaymentCollectionType.mdx @@ -10,6 +10,6 @@ The payment collection's type. ## References -### ORDER\_EDIT +#### ORDER\_EDIT -Re-exports [ORDER_EDIT](../index.md#order_edit) + **ORDER\_EDIT** = [object Object] diff --git a/www/apps/docs/content/references/services/enums/PaymentSessionStatus.mdx b/www/apps/docs/content/references/services/enums/PaymentSessionStatus.mdx index bd4867115b..8c8c864301 100644 --- a/www/apps/docs/content/references/services/enums/PaymentSessionStatus.mdx +++ b/www/apps/docs/content/references/services/enums/PaymentSessionStatus.mdx @@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### AUTHORIZED +#### AUTHORIZED **AUTHORIZED** = `"authorized"` ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` ___ -### ERROR +#### ERROR **ERROR** = `"error"` ___ -### PENDING +#### PENDING **PENDING** = `"pending"` ___ -### REQUIRES\_MORE +#### REQUIRES\_MORE **REQUIRES\_MORE** = `"requires_more"` diff --git a/www/apps/docs/content/references/services/enums/PaymentStatus-1.mdx b/www/apps/docs/content/references/services/enums/PaymentStatus-1.mdx index e762583767..a0080615ae 100644 --- a/www/apps/docs/content/references/services/enums/PaymentStatus-1.mdx +++ b/www/apps/docs/content/references/services/enums/PaymentStatus-1.mdx @@ -10,7 +10,7 @@ The payment status of the order. ## Enumeration Members -### awaiting +#### awaiting **awaiting** = `"awaiting"` @@ -18,7 +18,7 @@ The order's payment is awaiting. ___ -### canceled +#### canceled **canceled** = `"canceled"` @@ -26,7 +26,7 @@ The order's payment is canceled. ___ -### captured +#### captured **captured** = `"captured"` @@ -34,7 +34,7 @@ The order's payment is captured. ___ -### not\_paid +#### not\_paid **not\_paid** = `"not_paid"` @@ -42,7 +42,7 @@ The order's payment isn't paid. ___ -### partially\_refunded +#### partially\_refunded **partially\_refunded** = `"partially_refunded"` @@ -50,7 +50,7 @@ The order's payment is partially refunded. ___ -### refunded +#### refunded **refunded** = `"refunded"` @@ -58,7 +58,7 @@ The order's payment is fully refunded. ___ -### requires\_action +#### requires\_action **requires\_action** = `"requires_action"` diff --git a/www/apps/docs/content/references/services/enums/PaymentStatus.mdx b/www/apps/docs/content/references/services/enums/PaymentStatus.mdx index e3de874f37..091bd594d5 100644 --- a/www/apps/docs/content/references/services/enums/PaymentStatus.mdx +++ b/www/apps/docs/content/references/services/enums/PaymentStatus.mdx @@ -10,7 +10,7 @@ The order's payment status. ## Enumeration Members -### AWAITING +#### AWAITING **AWAITING** = `"awaiting"` @@ -18,7 +18,7 @@ The order's payment is awaiting capturing. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -26,7 +26,7 @@ The order's payment is canceled. ___ -### CAPTURED +#### CAPTURED **CAPTURED** = `"captured"` @@ -34,7 +34,7 @@ The order's payment is captured. ___ -### NOT\_PAID +#### NOT\_PAID **NOT\_PAID** = `"not_paid"` @@ -42,7 +42,7 @@ The order's payment is not paid. ___ -### PARTIALLY\_REFUNDED +#### PARTIALLY\_REFUNDED **PARTIALLY\_REFUNDED** = `"partially_refunded"` @@ -50,7 +50,7 @@ Some of the order's payment amount is refunded. ___ -### REFUNDED +#### REFUNDED **REFUNDED** = `"refunded"` @@ -58,7 +58,7 @@ The order's payment amount is refunded. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/services/enums/PriceListStatus-1.mdx b/www/apps/docs/content/references/services/enums/PriceListStatus-1.mdx index 0e117081f7..b8e7840c91 100644 --- a/www/apps/docs/content/references/services/enums/PriceListStatus-1.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListStatus-1.mdx @@ -10,7 +10,7 @@ The status of a price list. ## Enumeration Members -### ACTIVE +#### ACTIVE **ACTIVE** = `"active"` @@ -18,7 +18,7 @@ The price list is active, meaning its prices are applied to customers. ___ -### DRAFT +#### DRAFT **DRAFT** = `"draft"` diff --git a/www/apps/docs/content/references/services/enums/PriceListStatus-2.mdx b/www/apps/docs/content/references/services/enums/PriceListStatus-2.mdx index 02ce053c8d..9b7f85ed26 100644 --- a/www/apps/docs/content/references/services/enums/PriceListStatus-2.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListStatus-2.mdx @@ -10,7 +10,7 @@ The price list's status. ## Enumeration Members -### ACTIVE +#### ACTIVE **ACTIVE** = `"active"` @@ -18,7 +18,7 @@ The price list is enabled and its prices can be used. ___ -### DRAFT +#### DRAFT **DRAFT** = `"draft"` diff --git a/www/apps/docs/content/references/services/enums/PriceListStatus.mdx b/www/apps/docs/content/references/services/enums/PriceListStatus.mdx index 1b1db889a2..6f57fb3567 100644 --- a/www/apps/docs/content/references/services/enums/PriceListStatus.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListStatus.mdx @@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### ACTIVE +#### ACTIVE **ACTIVE** = `"active"` ___ -### DRAFT +#### DRAFT **DRAFT** = `"draft"` diff --git a/www/apps/docs/content/references/services/enums/PriceListType-1.mdx b/www/apps/docs/content/references/services/enums/PriceListType-1.mdx index 7a4d7b7aea..733ebca992 100644 --- a/www/apps/docs/content/references/services/enums/PriceListType-1.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListType-1.mdx @@ -10,7 +10,7 @@ The type of price list. ## Enumeration Members -### OVERRIDE +#### OVERRIDE **OVERRIDE** = `"override"` @@ -18,7 +18,7 @@ The price list is used to override original prices for specific conditions. ___ -### SALE +#### SALE **SALE** = `"sale"` diff --git a/www/apps/docs/content/references/services/enums/PriceListType-2.mdx b/www/apps/docs/content/references/services/enums/PriceListType-2.mdx index dd2976d8d6..83a8bbeae1 100644 --- a/www/apps/docs/content/references/services/enums/PriceListType-2.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListType-2.mdx @@ -10,7 +10,7 @@ The price list's type. ## Enumeration Members -### OVERRIDE +#### OVERRIDE **OVERRIDE** = `"override"` @@ -18,7 +18,7 @@ The price list's prices override original prices. This affects the calculated pr ___ -### SALE +#### SALE **SALE** = `"sale"` diff --git a/www/apps/docs/content/references/services/enums/PriceListType.mdx b/www/apps/docs/content/references/services/enums/PriceListType.mdx index ba777803f1..353e58572c 100644 --- a/www/apps/docs/content/references/services/enums/PriceListType.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListType.mdx @@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### OVERRIDE +#### OVERRIDE **OVERRIDE** = `"override"` ___ -### SALE +#### SALE **SALE** = `"sale"` diff --git a/www/apps/docs/content/references/services/enums/ProductStatus.mdx b/www/apps/docs/content/references/services/enums/ProductStatus.mdx index 7a231383e9..e4931b2f47 100644 --- a/www/apps/docs/content/references/services/enums/ProductStatus.mdx +++ b/www/apps/docs/content/references/services/enums/ProductStatus.mdx @@ -10,7 +10,7 @@ The status of a product. ## Enumeration Members -### DRAFT +#### DRAFT **DRAFT** = `"draft"` @@ -18,7 +18,7 @@ The product is a draft. It's not viewable by customers. ___ -### PROPOSED +#### PROPOSED **PROPOSED** = `"proposed"` @@ -26,7 +26,7 @@ The product is proposed, but not yet published. ___ -### PUBLISHED +#### PUBLISHED **PUBLISHED** = `"published"` @@ -34,7 +34,7 @@ The product is published. ___ -### REJECTED +#### REJECTED **REJECTED** = `"rejected"` diff --git a/www/apps/docs/content/references/services/enums/RequirementType.mdx b/www/apps/docs/content/references/services/enums/RequirementType.mdx index 8b7088ab57..c20a45a9d6 100644 --- a/www/apps/docs/content/references/services/enums/RequirementType.mdx +++ b/www/apps/docs/content/references/services/enums/RequirementType.mdx @@ -10,7 +10,7 @@ The type of shipping option requirement. ## Enumeration Members -### MAX\_SUBTOTAL +#### MAX\_SUBTOTAL **MAX\_SUBTOTAL** = `"max_subtotal"` @@ -18,7 +18,7 @@ The shipping option can only be applied if the subtotal is less than the require ___ -### MIN\_SUBTOTAL +#### MIN\_SUBTOTAL **MIN\_SUBTOTAL** = `"min_subtotal"` diff --git a/www/apps/docs/content/references/services/enums/ReturnStatus.mdx b/www/apps/docs/content/references/services/enums/ReturnStatus.mdx index 9f01188f44..1210bf14ad 100644 --- a/www/apps/docs/content/references/services/enums/ReturnStatus.mdx +++ b/www/apps/docs/content/references/services/enums/ReturnStatus.mdx @@ -10,7 +10,7 @@ The return's status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The return is canceled. ___ -### RECEIVED +#### RECEIVED **RECEIVED** = `"received"` @@ -26,7 +26,7 @@ The return is received. ___ -### REQUESTED +#### REQUESTED **REQUESTED** = `"requested"` @@ -34,7 +34,7 @@ The return is requested. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/services/enums/ShippingOptionPriceType.mdx b/www/apps/docs/content/references/services/enums/ShippingOptionPriceType.mdx index be549e10c7..3a6ee88a10 100644 --- a/www/apps/docs/content/references/services/enums/ShippingOptionPriceType.mdx +++ b/www/apps/docs/content/references/services/enums/ShippingOptionPriceType.mdx @@ -10,7 +10,7 @@ The type of the shipping option price. ## Enumeration Members -### CALCULATED +#### CALCULATED **CALCULATED** = `"calculated"` @@ -18,7 +18,7 @@ The shipping option's price is calculated. In this case, the `amount` field is t ___ -### FLAT\_RATE +#### FLAT\_RATE **FLAT\_RATE** = `"flat_rate"` diff --git a/www/apps/docs/content/references/services/enums/ShippingProfileType.mdx b/www/apps/docs/content/references/services/enums/ShippingProfileType.mdx index faf20e815f..d85bd6af18 100644 --- a/www/apps/docs/content/references/services/enums/ShippingProfileType.mdx +++ b/www/apps/docs/content/references/services/enums/ShippingProfileType.mdx @@ -10,7 +10,7 @@ The shipping profile's type. ## Enumeration Members -### CUSTOM +#### CUSTOM **CUSTOM** = `"custom"` @@ -18,7 +18,7 @@ The profile used to ship custom items. ___ -### DEFAULT +#### DEFAULT **DEFAULT** = `"default"` @@ -26,7 +26,7 @@ The default profile used to ship item. ___ -### GIFT\_CARD +#### GIFT\_CARD **GIFT\_CARD** = `"gift_card"` diff --git a/www/apps/docs/content/references/services/enums/SwapFulfillmentStatus.mdx b/www/apps/docs/content/references/services/enums/SwapFulfillmentStatus.mdx index 0ecd3b6cc4..274f38c12f 100644 --- a/www/apps/docs/content/references/services/enums/SwapFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/services/enums/SwapFulfillmentStatus.mdx @@ -10,7 +10,7 @@ The swap's fulfillment status. ## Enumeration Members -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -18,7 +18,7 @@ The swap's fulfillments are canceled. ___ -### FULFILLED +#### FULFILLED **FULFILLED** = `"fulfilled"` @@ -26,7 +26,7 @@ The swap's items are fulfilled. ___ -### NOT\_FULFILLED +#### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` @@ -34,7 +34,7 @@ The swap's items aren't fulfilled. ___ -### PARTIALLY\_SHIPPED +#### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` @@ -42,7 +42,7 @@ Some of the swap's items are shipped. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` @@ -50,7 +50,7 @@ The swap's fulfillments require an action. ___ -### SHIPPED +#### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/services/enums/SwapPaymentStatus.mdx b/www/apps/docs/content/references/services/enums/SwapPaymentStatus.mdx index 6770814b72..ee25f72331 100644 --- a/www/apps/docs/content/references/services/enums/SwapPaymentStatus.mdx +++ b/www/apps/docs/content/references/services/enums/SwapPaymentStatus.mdx @@ -10,7 +10,7 @@ The swap's payment status. ## Enumeration Members -### AWAITING +#### AWAITING **AWAITING** = `"awaiting"` @@ -18,7 +18,7 @@ The swap is additional awaiting payment. ___ -### CANCELED +#### CANCELED **CANCELED** = `"canceled"` @@ -26,7 +26,7 @@ The swap's additional payment is canceled. ___ -### CAPTURED +#### CAPTURED **CAPTURED** = `"captured"` @@ -34,7 +34,7 @@ The swap's additional payment is captured. ___ -### CONFIRMED +#### CONFIRMED **CONFIRMED** = `"confirmed"` @@ -42,7 +42,7 @@ The swap's additional payment is confirmed. ___ -### DIFFERENCE\_REFUNDED +#### DIFFERENCE\_REFUNDED **DIFFERENCE\_REFUNDED** = `"difference_refunded"` @@ -50,7 +50,7 @@ The negative difference amount between the returned item(s) and the new one(s) h ___ -### NOT\_PAID +#### NOT\_PAID **NOT\_PAID** = `"not_paid"` @@ -58,7 +58,7 @@ The swap's additional payment isn't paid. ___ -### PARTIALLY\_REFUNDED +#### PARTIALLY\_REFUNDED **PARTIALLY\_REFUNDED** = `"partially_refunded"` @@ -66,7 +66,7 @@ Some of the negative difference amount between the returned item(s) and the new ___ -### REFUNDED +#### REFUNDED **REFUNDED** = `"refunded"` @@ -74,7 +74,7 @@ The amount in the associated order has been refunded. ___ -### REQUIRES\_ACTION +#### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/services/enums/UserRoles.mdx b/www/apps/docs/content/references/services/enums/UserRoles.mdx index 0a7fc82ddb..e7f9535e1d 100644 --- a/www/apps/docs/content/references/services/enums/UserRoles.mdx +++ b/www/apps/docs/content/references/services/enums/UserRoles.mdx @@ -10,7 +10,7 @@ The user's role. These roles don't change the user's capabilities or provide acc ## Enumeration Members -### ADMIN +#### ADMIN **ADMIN** = `"admin"` @@ -18,7 +18,7 @@ The user is an admin. ___ -### DEVELOPER +#### DEVELOPER **DEVELOPER** = `"developer"` @@ -26,7 +26,7 @@ The user is a developer. ___ -### MEMBER +#### MEMBER **MEMBER** = `"member"` diff --git a/www/apps/docs/content/references/services/index.md b/www/apps/docs/content/references/services/index.md index 3f62f82c94..9541af081e 100644 --- a/www/apps/docs/content/references/services/index.md +++ b/www/apps/docs/content/references/services/index.md @@ -231,7 +231,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [Buffer](interfaces/Buffer.mdx) - [BufferConstructor](interfaces/BufferConstructor.mdx) - [BulkUpdateInventoryLevelInput](interfaces/BulkUpdateInventoryLevelInput.mdx) -- [CalculatedPriceSetDTO](interfaces/CalculatedPriceSetDTO.mdx) +- [CalculatedPriceSet](interfaces/CalculatedPriceSet.mdx) - [Context](interfaces/Context.mdx) - [CreateCurrencyDTO](interfaces/CreateCurrencyDTO.mdx) - [CreateInventoryItemInput](interfaces/CreateInventoryItemInput.mdx) @@ -606,25 +606,25 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Enumeration Members -### DEFAULT +#### DEFAULT **DEFAULT**: `"default"` ___ -### EXTERNAL +#### EXTERNAL **EXTERNAL**: `"external"` ___ -### INTERNAL +#### INTERNAL **INTERNAL**: `"internal"` ___ -### ORDER\_EDIT +#### ORDER\_EDIT **ORDER\_EDIT**: `"order_edit"` @@ -632,221 +632,221 @@ The payment collection is used for an order edit. ## Variables -### AddressRepository +#### AddressRepository `Const` **AddressRepository**: Repository<[Address](classes/Address.mdx)> ___ -### AnalyticsConfigRepository +#### AnalyticsConfigRepository `Const` **AnalyticsConfigRepository**: Repository<[AnalyticsConfig](classes/AnalyticsConfig.mdx)> ___ -### BatchJobRepository +#### BatchJobRepository `Const` **BatchJobRepository**: Repository<[BatchJob](classes/BatchJob.mdx)> ___ -### Buffer +#### Buffer **Buffer**: [BufferConstructor](interfaces/BufferConstructor.mdx) ___ -### CartRepository +#### CartRepository `Const` **CartRepository**: Repository<[Cart](classes/Cart.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`` ___ -### ClaimRepository +#### ClaimRepository `Const` **ClaimRepository**: Repository<[ClaimOrder](classes/ClaimOrder.mdx)> ___ -### CountryRepository +#### CountryRepository `Const` **CountryRepository**: Repository<[Country](classes/Country.mdx)> ___ -### CurrencyRepository +#### CurrencyRepository `Const` **CurrencyRepository**: Repository<[Currency](classes/Currency.mdx)> ___ -### CustomShippingOptionRepository +#### CustomShippingOptionRepository `Const` **CustomShippingOptionRepository**: Repository<[CustomShippingOption](classes/CustomShippingOption.mdx)> ___ -### CustomerGroupRepository +#### CustomerGroupRepository `Const` **CustomerGroupRepository**: Repository<[CustomerGroup](classes/CustomerGroup.mdx)> & ``{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }`` ___ -### CustomerRepository +#### CustomerRepository `Const` **CustomerRepository**: Repository<[Customer](classes/Customer.mdx)> & ``{ listAndCount: Method listAndCount }`` ___ -### DiscountConditionRepository +#### DiscountConditionRepository `Const` **DiscountConditionRepository**: Repository<[DiscountCondition](classes/DiscountCondition.mdx)> & ``{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }`` ___ -### DraftOrderRepository +#### DraftOrderRepository `Const` **DraftOrderRepository**: Repository<[DraftOrder](classes/DraftOrder.mdx)> ___ -### FulfillmentProviderRepository +#### FulfillmentProviderRepository `Const` **FulfillmentProviderRepository**: Repository<[FulfillmentProvider](classes/FulfillmentProvider.mdx)> ___ -### FulfillmentRepository +#### FulfillmentRepository `Const` **FulfillmentRepository**: Repository<[Fulfillment](classes/Fulfillment.mdx)> ___ -### GiftCardRepository +#### GiftCardRepository `Const` **GiftCardRepository**: Repository<[GiftCard](classes/GiftCard.mdx)> & ``{ listGiftCardsAndCount: Method listGiftCardsAndCount }`` ___ -### GiftCardTransactionRepository +#### GiftCardTransactionRepository `Const` **GiftCardTransactionRepository**: Repository<[GiftCardTransaction](classes/GiftCardTransaction.mdx)> ___ -### IdempotencyKeyRepository +#### IdempotencyKeyRepository `Const` **IdempotencyKeyRepository**: Repository<[IdempotencyKey](classes/IdempotencyKey.mdx)> ___ -### ImageRepository +#### ImageRepository `Const` **ImageRepository**: Repository<[Image](classes/Image.mdx)> & ``{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }`` ___ -### LineItemAdjustmentRepository +#### LineItemAdjustmentRepository `Const` **LineItemAdjustmentRepository**: Repository<[LineItemAdjustment](classes/LineItemAdjustment.mdx)> ___ -### LineItemRepository +#### LineItemRepository `Const` **LineItemRepository**: Repository<[LineItem](classes/LineItem.mdx)> & ``{ findByReturn: Method findByReturn }`` ___ -### LineItemTaxLineRepository +#### LineItemTaxLineRepository `Const` **LineItemTaxLineRepository**: Repository<[LineItemTaxLine](classes/LineItemTaxLine.mdx)> & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`` ___ -### MoneyAmountRepository +#### MoneyAmountRepository `Const` **MoneyAmountRepository**: Repository<[MoneyAmount](classes/MoneyAmount.mdx)> & ``{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }`` ___ -### NoteRepository +#### NoteRepository `Const` **NoteRepository**: Repository<[Note](classes/Note.mdx)> ___ -### NotificationProviderRepository +#### NotificationProviderRepository `Const` **NotificationProviderRepository**: Repository<[NotificationProvider](classes/NotificationProvider.mdx)> ___ -### NotificationRepository +#### NotificationRepository `Const` **NotificationRepository**: Repository<[Notification](classes/Notification.mdx)> ___ -### OauthRepository +#### OauthRepository `Const` **OauthRepository**: Repository<[Oauth](classes/Oauth.mdx)> ___ -### OrderEditRepository +#### OrderEditRepository `Const` **OrderEditRepository**: Repository<[OrderEdit](classes/OrderEdit.mdx)> ___ -### OrderItemChangeRepository +#### OrderItemChangeRepository `Const` **OrderItemChangeRepository**: Repository<[OrderItemChange](classes/OrderItemChange.mdx)> ___ -### OrderRepository +#### OrderRepository `Const` **OrderRepository**: Repository<[Order](classes/Order.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`` ___ -### PaymentCollectionRepository +#### PaymentCollectionRepository `Const` **PaymentCollectionRepository**: Repository<[PaymentCollection](classes/PaymentCollection.mdx)> & ``{ getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId }`` ___ -### PaymentProviderRepository +#### PaymentProviderRepository `Const` **PaymentProviderRepository**: Repository<[PaymentProvider](classes/PaymentProvider.mdx)> ___ -### PaymentRepository +#### PaymentRepository `Const` **PaymentRepository**: Repository<[Payment](classes/Payment.mdx)> ___ -### PaymentSessionRepository +#### PaymentSessionRepository `Const` **PaymentSessionRepository**: Repository<[PaymentSession](classes/PaymentSession.mdx)> ___ -### PriceListRepository +#### PriceListRepository `Const` **PriceListRepository**: Repository<[PriceList](classes/PriceList.mdx)> & ``{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }`` ___ -### PriceType +#### PriceType **PriceType**: `Object` -### Type declaration +#### Type declaration (value?): boolean` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` diff --git a/www/apps/docs/content/references/services/interfaces/Boolean.mdx b/www/apps/docs/content/references/services/interfaces/Boolean.mdx index 4214f3a38e..99cbfdad2e 100644 --- a/www/apps/docs/content/references/services/interfaces/Boolean.mdx +++ b/www/apps/docs/content/references/services/interfaces/Boolean.mdx @@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### valueOf +#### valueOf `**valueOf**(): boolean` Returns the primitive value of the specified object. -#### Returns +##### Returns `boolean` diff --git a/www/apps/docs/content/references/services/interfaces/Buffer.mdx b/www/apps/docs/content/references/services/interfaces/Buffer.mdx index 573e7f0dd3..1d8696685d 100644 --- a/www/apps/docs/content/references/services/interfaces/Buffer.mdx +++ b/www/apps/docs/content/references/services/interfaces/Buffer.mdx @@ -67,11 +67,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### [iterator] +#### [iterator] `**[iterator]**(): [IterableIterator](IterableIterator.mdx)<number>` -#### Returns +##### Returns [IterableIterator](IterableIterator.mdx)<number> @@ -89,13 +89,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ___ -### at +#### at `**at**(index): undefined \| number` Returns the item located at the specified index. -#### Parameters +##### Parameters -#### Returns +##### Returns `undefined` \| `number` @@ -127,7 +127,7 @@ Returns the item located at the specified index. ___ -### compare +#### compare `**compare**(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): 0 \| 1 \| -1` @@ -178,7 +178,7 @@ console.log(buf1.compare(buf2, 5, 6, 5)); `ERR_OUT_OF_RANGE` is thrown if `targetStart < 0`, `sourceStart < 0`,`targetEnd > target.byteLength`, or `sourceEnd > source.byteLength`. -#### Parameters +##### Parameters -#### Returns +##### Returns `0` \| `1` \| `-1` @@ -250,7 +250,7 @@ v0.11.13 ___ -### copy +#### copy `**copy**(target, targetStart?, sourceStart?, sourceEnd?): number` @@ -300,7 +300,7 @@ console.log(buf.toString()); // Prints: efghijghijklmnopqrstuvwxyz ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -363,14 +363,14 @@ v0.1.90 ___ -### copyWithin +#### copyWithin `**copyWithin**(target, start, end?): [Buffer](../index.md#buffer)` Returns the this object after copying a section of the array identified by start and end to the same array starting at position target -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -420,7 +420,7 @@ to the same array starting at position target ___ -### entries +#### entries `**entries**(): [IterableIterator](IterableIterator.mdx)<[number, number]>` @@ -446,7 +446,7 @@ for (const pair of buf.entries()) { // [5, 114] ``` -#### Returns +##### Returns [IterableIterator](IterableIterator.mdx)<[number, number]> @@ -468,7 +468,7 @@ v1.1.0 ___ -### equals +#### equals `**equals**(otherBuffer): boolean` @@ -487,7 +487,7 @@ console.log(buf1.equals(buf3)); // Prints: false ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -523,13 +523,13 @@ v0.11.13 ___ -### every +#### every `**every**(predicate, thisArg?): boolean` Determines whether all the members of an array satisfy the specified test. -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -570,7 +570,7 @@ Determines whether all the members of an array satisfy the specified test. ___ -### fill +#### fill `**fill**(value, offset?, end?, encoding?): [Buffer](../index.md#buffer)` @@ -626,7 +626,7 @@ console.log(buf.fill('zz', 'hex')); // Throws an exception. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -689,13 +689,13 @@ v0.5.0 ___ -### filter +#### filter `**filter**(predicate, thisArg?): Uint8Array` Returns the elements of an array that meet the condition specified in a callback function. -#### Parameters +##### Parameters -#### Returns +##### Returns Uint8Array @@ -736,14 +736,14 @@ Uint8Array ___ -### find +#### find `**find**(predicate, thisArg?): undefined \| number` Returns the value of the first element in the array where predicate is true, and undefined otherwise. -#### Parameters +##### Parameters -#### Returns +##### Returns `undefined` \| `number` @@ -784,14 +784,14 @@ otherwise. ___ -### findIndex +#### findIndex `**findIndex**(predicate, thisArg?): number` Returns the index of the first element in the array where predicate is true, and -1 otherwise. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -832,13 +832,15 @@ otherwise. ___ -### findLast +#### findLast `**findLast**(predicate, thisArg?): undefined \| S` Returns the value of the last element in the array where predicate is true, and undefined otherwise. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `undefined` \| `S` @@ -892,7 +894,7 @@ otherwise. `**findLast**(predicate, thisArg?): undefined \| number` -#### Parameters +##### Parameters -#### Returns +##### Returns `undefined` \| `number` @@ -933,14 +935,14 @@ otherwise. ___ -### findLastIndex +#### findLastIndex `**findLastIndex**(predicate, thisArg?): number` Returns the index of the last element in the array where predicate is true, and -1 otherwise. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -981,13 +983,13 @@ otherwise. ___ -### forEach +#### forEach `**forEach**(callbackfn, thisArg?): void` Performs the specified action for each element in an array. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -1028,7 +1030,7 @@ Performs the specified action for each element in an array. ___ -### includes +#### includes `**includes**(value, byteOffset?, encoding?): boolean` @@ -1055,7 +1057,7 @@ console.log(buf.includes('this', 4)); // Prints: false ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -1109,7 +1111,7 @@ v5.3.0 ___ -### indexOf +#### indexOf `**indexOf**(value, byteOffset?, encoding?): number` @@ -1175,7 +1177,7 @@ console.log(b.indexOf('b', [])); If `value` is an empty string or empty `Buffer` and `byteOffset` is less than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOffset` is at least `buf.length`, `buf.length` will be returned. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1229,13 +1231,13 @@ v1.5.0 ___ -### join +#### join `**join**(separator?): string` Adds all the elements of an array separated by the specified separator string. -#### Parameters +##### Parameters -#### Returns +##### Returns `string` @@ -1267,7 +1269,7 @@ Adds all the elements of an array separated by the specified separator string. ___ -### keys +#### keys `**keys**(): [IterableIterator](IterableIterator.mdx)<number>` @@ -1290,7 +1292,7 @@ for (const key of buf.keys()) { // 5 ``` -#### Returns +##### Returns [IterableIterator](IterableIterator.mdx)<number> @@ -1312,7 +1314,7 @@ v1.1.0 ___ -### lastIndexOf +#### lastIndexOf `**lastIndexOf**(value, byteOffset?, encoding?): number` @@ -1377,7 +1379,7 @@ console.log(b.lastIndexOf('b', [])); If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1431,14 +1433,14 @@ v6.0.0 ___ -### map +#### map `**map**(callbackfn, thisArg?): Uint8Array` Calls a defined callback function on each element of an array, and returns an array that contains the results. -#### Parameters +##### Parameters -#### Returns +##### Returns Uint8Array @@ -1479,7 +1481,7 @@ Uint8Array ___ -### readBigInt64BE +#### readBigInt64BE `**readBigInt64BE**(offset?): bigint` @@ -1488,7 +1490,7 @@ Reads a signed, big-endian 64-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer` are interpreted as two's complement signed values. -#### Parameters +##### Parameters -#### Returns +##### Returns `bigint` @@ -1524,7 +1526,7 @@ v12.0.0, v10.20.0 ___ -### readBigInt64LE +#### readBigInt64LE `**readBigInt64LE**(offset?): bigint` @@ -1533,7 +1535,7 @@ Reads a signed, little-endian 64-bit integer from `buf` at the specified`offset` Integers read from a `Buffer` are interpreted as two's complement signed values. -#### Parameters +##### Parameters -#### Returns +##### Returns `bigint` @@ -1569,7 +1571,7 @@ v12.0.0, v10.20.0 ___ -### readBigUInt64BE +#### readBigUInt64BE `**readBigUInt64BE**(offset?): bigint` @@ -1586,7 +1588,7 @@ console.log(buf.readBigUInt64BE(0)); // Prints: 4294967295n ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `bigint` @@ -1622,7 +1624,7 @@ v12.0.0, v10.20.0 ___ -### readBigUInt64LE +#### readBigUInt64LE `**readBigUInt64LE**(offset?): bigint` @@ -1639,7 +1641,7 @@ console.log(buf.readBigUInt64LE(0)); // Prints: 18446744069414584320n ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `bigint` @@ -1675,11 +1677,11 @@ v12.0.0, v10.20.0 ___ -### readBigUint64BE +#### readBigUint64BE `**readBigUint64BE**(offset?): bigint` -#### Parameters +##### Parameters -#### Returns +##### Returns `bigint` @@ -1719,11 +1721,11 @@ v14.10.0, v12.19.0 ___ -### readBigUint64LE +#### readBigUint64LE `**readBigUint64LE**(offset?): bigint` -#### Parameters +##### Parameters -#### Returns +##### Returns `bigint` @@ -1763,7 +1765,7 @@ v14.10.0, v12.19.0 ___ -### readDoubleBE +#### readDoubleBE `**readDoubleBE**(offset?): number` @@ -1778,7 +1780,7 @@ console.log(buf.readDoubleBE(0)); // Prints: 8.20788039913184e-304 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1814,7 +1816,7 @@ v0.11.15 ___ -### readDoubleLE +#### readDoubleLE `**readDoubleLE**(offset?): number` @@ -1831,7 +1833,7 @@ console.log(buf.readDoubleLE(1)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1867,7 +1869,7 @@ v0.11.15 ___ -### readFloatBE +#### readFloatBE `**readFloatBE**(offset?): number` @@ -1882,7 +1884,7 @@ console.log(buf.readFloatBE(0)); // Prints: 2.387939260590663e-38 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1918,7 +1920,7 @@ v0.11.15 ___ -### readFloatLE +#### readFloatLE `**readFloatLE**(offset?): number` @@ -1935,7 +1937,7 @@ console.log(buf.readFloatLE(1)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -1971,7 +1973,7 @@ v0.11.15 ___ -### readInt16BE +#### readInt16BE `**readInt16BE**(offset?): number` @@ -1988,7 +1990,7 @@ console.log(buf.readInt16BE(0)); // Prints: 5 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2024,7 +2026,7 @@ v0.5.5 ___ -### readInt16LE +#### readInt16LE `**readInt16LE**(offset?): number` @@ -2043,7 +2045,7 @@ console.log(buf.readInt16LE(1)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2079,7 +2081,7 @@ v0.5.5 ___ -### readInt32BE +#### readInt32BE `**readInt32BE**(offset?): number` @@ -2096,7 +2098,7 @@ console.log(buf.readInt32BE(0)); // Prints: 5 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2132,7 +2134,7 @@ v0.5.5 ___ -### readInt32LE +#### readInt32LE `**readInt32LE**(offset?): number` @@ -2151,7 +2153,7 @@ console.log(buf.readInt32LE(1)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2187,7 +2189,7 @@ v0.5.5 ___ -### readInt8 +#### readInt8 `**readInt8**(offset?): number` @@ -2208,7 +2210,7 @@ console.log(buf.readInt8(2)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2244,7 +2246,7 @@ v0.5.0 ___ -### readIntBE +#### readIntBE `**readIntBE**(offset, byteLength): number` @@ -2264,7 +2266,7 @@ console.log(buf.readIntBE(1, 0).toString(16)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2309,7 +2311,7 @@ v0.11.15 ___ -### readIntLE +#### readIntLE `**readIntLE**(offset, byteLength): number` @@ -2325,7 +2327,7 @@ console.log(buf.readIntLE(0, 6).toString(16)); // Prints: -546f87a9cbee ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2370,7 +2372,7 @@ v0.11.15 ___ -### readUInt16BE +#### readUInt16BE `**readUInt16BE**(offset?): number` @@ -2389,7 +2391,7 @@ console.log(buf.readUInt16BE(1).toString(16)); // Prints: 3456 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2425,7 +2427,7 @@ v0.5.5 ___ -### readUInt16LE +#### readUInt16LE `**readUInt16LE**(offset?): number` @@ -2446,7 +2448,7 @@ console.log(buf.readUInt16LE(2).toString(16)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2482,7 +2484,7 @@ v0.5.5 ___ -### readUInt32BE +#### readUInt32BE `**readUInt32BE**(offset?): number` @@ -2499,7 +2501,7 @@ console.log(buf.readUInt32BE(0).toString(16)); // Prints: 12345678 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2535,7 +2537,7 @@ v0.5.5 ___ -### readUInt32LE +#### readUInt32LE `**readUInt32LE**(offset?): number` @@ -2554,7 +2556,7 @@ console.log(buf.readUInt32LE(1).toString(16)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2590,7 +2592,7 @@ v0.5.5 ___ -### readUInt8 +#### readUInt8 `**readUInt8**(offset?): number` @@ -2611,7 +2613,7 @@ console.log(buf.readUInt8(2)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2647,7 +2649,7 @@ v0.5.0 ___ -### readUIntBE +#### readUIntBE `**readUIntBE**(offset, byteLength): number` @@ -2667,7 +2669,7 @@ console.log(buf.readUIntBE(1, 6).toString(16)); // Throws ERR_OUT_OF_RANGE. ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2712,7 +2714,7 @@ v0.11.15 ___ -### readUIntLE +#### readUIntLE `**readUIntLE**(offset, byteLength): number` @@ -2730,7 +2732,7 @@ console.log(buf.readUIntLE(0, 6).toString(16)); // Prints: ab9078563412 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2775,11 +2777,11 @@ v0.11.15 ___ -### readUint16BE +#### readUint16BE `**readUint16BE**(offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2819,11 +2821,11 @@ v14.9.0, v12.19.0 ___ -### readUint16LE +#### readUint16LE `**readUint16LE**(offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2863,11 +2865,11 @@ v14.9.0, v12.19.0 ___ -### readUint32BE +#### readUint32BE `**readUint32BE**(offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2907,11 +2909,11 @@ v14.9.0, v12.19.0 ___ -### readUint32LE +#### readUint32LE `**readUint32LE**(offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2951,11 +2953,11 @@ v14.9.0, v12.19.0 ___ -### readUint8 +#### readUint8 `**readUint8**(offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -2995,11 +2997,11 @@ v14.9.0, v12.19.0 ___ -### readUintBE +#### readUintBE `**readUintBE**(offset, byteLength): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -3048,11 +3050,11 @@ v14.9.0, v12.19.0 ___ -### readUintLE +#### readUintLE `**readUintLE**(offset, byteLength): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -3101,7 +3103,7 @@ v14.9.0, v12.19.0 ___ -### reduce +#### reduce `**reduce**(callbackfn): number` @@ -3109,7 +3111,7 @@ Calls the specified callback function for all the elements in an array. The retu the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -3141,7 +3143,7 @@ call to the callback function. `**reduce**(callbackfn, initialValue): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -3186,6 +3188,8 @@ Calls the specified callback function for all the elements in an array. The retu the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `U` - + ___ -### reduceRight +#### reduceRight `**reduceRight**(callbackfn): number` @@ -3237,7 +3251,7 @@ Calls the specified callback function for all the elements in an array, in desce The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -3269,7 +3283,7 @@ argument in the next call to the callback function. `**reduceRight**(callbackfn, initialValue): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -3314,6 +3328,8 @@ Calls the specified callback function for all the elements in an array, in desce The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns `U` - + ___ -### reverse +#### reverse `**reverse**(): [Buffer](../index.md#buffer)` -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -3379,13 +3405,13 @@ ___ ___ -### set +#### set `**set**(array, offset?): void` Sets a value or an array of values. -#### Parameters +##### Parameters -#### Returns +##### Returns `void` @@ -3426,7 +3452,7 @@ Sets a value or an array of values. ___ -### slice +#### slice `**slice**(start?, end?): [Buffer](../index.md#buffer)` @@ -3458,7 +3484,7 @@ console.log(buf.toString()); // Also prints: cuffer (!) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -3507,13 +3533,13 @@ Use `subarray` instead. ___ -### some +#### some `**some**(predicate, thisArg?): boolean` Determines whether the specified callback function returns true for any element of an array. -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -3554,13 +3580,13 @@ Determines whether the specified callback function returns true for any element ___ -### sort +#### sort `**sort**(compareFn?): [Buffer](../index.md#buffer)` Sorts an array. -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -3592,7 +3618,7 @@ Sorts an array. ___ -### subarray +#### subarray `**subarray**(start?, end?): [Buffer](../index.md#buffer)` @@ -3651,7 +3677,7 @@ console.log(buf.subarray(-5, -2).toString()); // (Equivalent to buf.subarray(1, 4).) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -3696,7 +3722,7 @@ v3.0.0 ___ -### swap16 +#### swap16 `**swap16**(): [Buffer](../index.md#buffer)` @@ -3732,7 +3758,7 @@ const buf = Buffer.from('This is little-endian UTF-16', 'utf16le'); buf.swap16(); // Convert to big-endian UTF-16 text. ``` -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -3754,7 +3780,7 @@ v5.10.0 ___ -### swap32 +#### swap32 `**swap32**(): [Buffer](../index.md#buffer)` @@ -3780,7 +3806,7 @@ buf2.swap32(); // Throws ERR_INVALID_BUFFER_SIZE. ``` -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -3802,7 +3828,7 @@ v5.10.0 ___ -### swap64 +#### swap64 `**swap64**(): [Buffer](../index.md#buffer)` @@ -3828,7 +3854,7 @@ buf2.swap64(); // Throws ERR_INVALID_BUFFER_SIZE. ``` -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -3850,7 +3876,7 @@ v6.3.0 ___ -### toJSON +#### toJSON `**toJSON**(): { data: number[] ; type: "Buffer" }` @@ -3879,7 +3905,7 @@ console.log(copy); // Prints: ``` -#### Returns +##### Returns `object` @@ -3922,13 +3948,13 @@ v0.9.2 ___ -### toLocaleString +#### toLocaleString `**toLocaleString**(): string` Converts a number to a string by using the current locale. -#### Returns +##### Returns `string` @@ -3946,13 +3972,13 @@ Converts a number to a string by using the current locale. ___ -### toReversed +#### toReversed `**toReversed**(): Uint8Array` Copies the array and returns the copy with the elements in reverse order. -#### Returns +##### Returns Uint8Array @@ -3970,13 +3996,13 @@ Uint8Array ___ -### toSorted +#### toSorted `**toSorted**(compareFn?): Uint8Array` Copies and sorts the array. -#### Parameters +##### Parameters -#### Returns +##### Returns Uint8Array @@ -4008,7 +4034,7 @@ Uint8Array ___ -### toString +#### toString `**toString**(encoding?, start?, end?): string` @@ -4045,7 +4071,7 @@ console.log(buf2.toString(undefined, 0, 3)); // Prints: té ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `string` @@ -4099,13 +4125,13 @@ v0.1.90 ___ -### valueOf +#### valueOf `**valueOf**(): Uint8Array` Returns the primitive value of the specified object. -#### Returns +##### Returns Uint8Array @@ -4123,7 +4149,7 @@ Uint8Array ___ -### values +#### values `**values**(): [IterableIterator](IterableIterator.mdx)<number>` @@ -4158,7 +4184,7 @@ for (const value of buf) { // 114 ``` -#### Returns +##### Returns [IterableIterator](IterableIterator.mdx)<number> @@ -4180,13 +4206,13 @@ v1.1.0 ___ -### with +#### with `**with**(index, value): Uint8Array` Copies the array and inserts the given number at the provided index. -#### Parameters +##### Parameters -#### Returns +##### Returns Uint8Array @@ -4227,7 +4253,7 @@ Uint8Array ___ -### write +#### write `**write**(string, encoding?): number` @@ -4253,7 +4279,7 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`); // Prints: 2 bytes : ab ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4298,7 +4324,7 @@ v0.1.90 `**write**(string, offset, encoding?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4348,7 +4374,7 @@ v0.1.90 `**write**(string, offset, length, encoding?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4407,7 +4433,7 @@ v0.1.90 ___ -### writeBigInt64BE +#### writeBigInt64BE `**writeBigInt64BE**(value, offset?): number` @@ -4426,7 +4452,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4471,7 +4497,7 @@ v12.0.0, v10.20.0 ___ -### writeBigInt64LE +#### writeBigInt64LE `**writeBigInt64LE**(value, offset?): number` @@ -4490,7 +4516,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4535,7 +4561,7 @@ v12.0.0, v10.20.0 ___ -### writeBigUInt64BE +#### writeBigUInt64BE `**writeBigUInt64BE**(value, offset?): number` @@ -4554,7 +4580,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4599,7 +4625,7 @@ v12.0.0, v10.20.0 ___ -### writeBigUInt64LE +#### writeBigUInt64LE `**writeBigUInt64LE**(value, offset?): number` @@ -4618,7 +4644,7 @@ console.log(buf); This function is also available under the `writeBigUint64LE` alias. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4663,11 +4689,11 @@ v12.0.0, v10.20.0 ___ -### writeBigUint64BE +#### writeBigUint64BE `**writeBigUint64BE**(value, offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4716,11 +4742,11 @@ v14.10.0, v12.19.0 ___ -### writeBigUint64LE +#### writeBigUint64LE `**writeBigUint64LE**(value, offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4769,7 +4795,7 @@ v14.10.0, v12.19.0 ___ -### writeDoubleBE +#### writeDoubleBE `**writeDoubleBE**(value, offset?): number` @@ -4787,7 +4813,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4832,7 +4858,7 @@ v0.11.15 ___ -### writeDoubleLE +#### writeDoubleLE `**writeDoubleLE**(value, offset?): number` @@ -4850,7 +4876,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4895,7 +4921,7 @@ v0.11.15 ___ -### writeFloatBE +#### writeFloatBE `**writeFloatBE**(value, offset?): number` @@ -4913,7 +4939,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -4958,7 +4984,7 @@ v0.11.15 ___ -### writeFloatLE +#### writeFloatLE `**writeFloatLE**(value, offset?): number` @@ -4976,7 +5002,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5021,7 +5047,7 @@ v0.11.15 ___ -### writeInt16BE +#### writeInt16BE `**writeInt16BE**(value, offset?): number` @@ -5041,7 +5067,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5086,7 +5112,7 @@ v0.5.5 ___ -### writeInt16LE +#### writeInt16LE `**writeInt16LE**(value, offset?): number` @@ -5106,7 +5132,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5151,7 +5177,7 @@ v0.5.5 ___ -### writeInt32BE +#### writeInt32BE `**writeInt32BE**(value, offset?): number` @@ -5171,7 +5197,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5216,7 +5242,7 @@ v0.5.5 ___ -### writeInt32LE +#### writeInt32LE `**writeInt32LE**(value, offset?): number` @@ -5236,7 +5262,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5281,7 +5307,7 @@ v0.5.5 ___ -### writeInt8 +#### writeInt8 `**writeInt8**(value, offset?): number` @@ -5303,7 +5329,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5348,7 +5374,7 @@ v0.5.0 ___ -### writeIntBE +#### writeIntBE `**writeIntBE**(value, offset, byteLength): number` @@ -5366,7 +5392,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5420,7 +5446,7 @@ v0.11.15 ___ -### writeIntLE +#### writeIntLE `**writeIntLE**(value, offset, byteLength): number` @@ -5438,7 +5464,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5492,7 +5518,7 @@ v0.11.15 ___ -### writeUInt16BE +#### writeUInt16BE `**writeUInt16BE**(value, offset?): number` @@ -5513,7 +5539,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5558,7 +5584,7 @@ v0.5.5 ___ -### writeUInt16LE +#### writeUInt16LE `**writeUInt16LE**(value, offset?): number` @@ -5579,7 +5605,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5624,7 +5650,7 @@ v0.5.5 ___ -### writeUInt32BE +#### writeUInt32BE `**writeUInt32BE**(value, offset?): number` @@ -5644,7 +5670,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5689,7 +5715,7 @@ v0.5.5 ___ -### writeUInt32LE +#### writeUInt32LE `**writeUInt32LE**(value, offset?): number` @@ -5709,7 +5735,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5754,7 +5780,7 @@ v0.5.5 ___ -### writeUInt8 +#### writeUInt8 `**writeUInt8**(value, offset?): number` @@ -5778,7 +5804,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5823,7 +5849,7 @@ v0.5.0 ___ -### writeUIntBE +#### writeUIntBE `**writeUIntBE**(value, offset, byteLength): number` @@ -5843,7 +5869,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5897,7 +5923,7 @@ v0.5.5 ___ -### writeUIntLE +#### writeUIntLE `**writeUIntLE**(value, offset, byteLength): number` @@ -5917,7 +5943,7 @@ console.log(buf); // Prints: ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -5971,11 +5997,11 @@ v0.5.5 ___ -### writeUint16BE +#### writeUint16BE `**writeUint16BE**(value, offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -6024,11 +6050,11 @@ v14.9.0, v12.19.0 ___ -### writeUint16LE +#### writeUint16LE `**writeUint16LE**(value, offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -6077,11 +6103,11 @@ v14.9.0, v12.19.0 ___ -### writeUint32BE +#### writeUint32BE `**writeUint32BE**(value, offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -6130,11 +6156,11 @@ v14.9.0, v12.19.0 ___ -### writeUint32LE +#### writeUint32LE `**writeUint32LE**(value, offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -6183,11 +6209,11 @@ v14.9.0, v12.19.0 ___ -### writeUint8 +#### writeUint8 `**writeUint8**(value, offset?): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -6236,11 +6262,11 @@ v14.9.0, v12.19.0 ___ -### writeUintBE +#### writeUintBE `**writeUintBE**(value, offset, byteLength): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -6298,11 +6324,11 @@ v14.9.0, v12.19.0 ___ -### writeUintLE +#### writeUintLE `**writeUintLE**(value, offset, byteLength): number` -#### Parameters +##### Parameters -#### Returns +##### Returns `number` diff --git a/www/apps/docs/content/references/services/interfaces/BufferConstructor.mdx b/www/apps/docs/content/references/services/interfaces/BufferConstructor.mdx index 4d766a1b49..bc494bc893 100644 --- a/www/apps/docs/content/references/services/interfaces/BufferConstructor.mdx +++ b/www/apps/docs/content/references/services/interfaces/BufferConstructor.mdx @@ -12,13 +12,13 @@ Valid string encodings: 'ascii'\|'utf8'\|'utf16le'\|'ucs2'(alias of 'utf16le')\| ## Constructors -### constructor +#### constructor `**new BufferConstructor**(str, encoding?)` Allocates a new buffer containing the given {str}. -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -272,7 +272,7 @@ v5.10.0 ___ -### allocUnsafe +#### allocUnsafe `**allocUnsafe**(size): [Buffer](../index.md#buffer)` @@ -308,7 +308,7 @@ than or equal to half `Buffer.poolSize`. The difference is subtle but can be important when an application requires the additional performance that `Buffer.allocUnsafe()` provides. -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -344,7 +344,7 @@ v5.10.0 ___ -### allocUnsafeSlow +#### allocUnsafeSlow `**allocUnsafeSlow**(size): [Buffer](../index.md#buffer)` @@ -389,7 +389,7 @@ socket.on('readable', () => { A `TypeError` will be thrown if `size` is not a number. -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -425,7 +425,7 @@ v5.12.0 ___ -### byteLength +#### byteLength `**byteLength**(string, encoding?): number` @@ -453,7 +453,7 @@ When `string` is a Reference/Global\_Objects/TypedArray)/[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/ArrayBuffer)/[`SharedArrayBuffer`](https://develop- er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/SharedArrayBuffer), the byte length as reported by `.byteLength`is returned. -#### Parameters +##### Parameters -#### Returns +##### Returns `number` @@ -498,7 +498,7 @@ v0.1.90 ___ -### compare +#### compare `**compare**(buf1, buf2): 0 \| 1 \| -1` @@ -516,7 +516,7 @@ console.log(arr.sort(Buffer.compare)); // (This result is equal to: [buf2, buf1].) ``` -#### Parameters +##### Parameters -#### Returns +##### Returns `0` \| `1` \| `-1` @@ -561,7 +561,7 @@ v0.11.13 ___ -### concat +#### concat `**concat**(list, totalLength?): [Buffer](../index.md#buffer)` @@ -599,7 +599,7 @@ console.log(bufA.length); `Buffer.concat()` may also use the internal `Buffer` pool like `Buffer.allocUnsafe()` does. -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -644,7 +644,7 @@ v0.7.11 ___ -### copyBytesFrom +#### copyBytesFrom `**copyBytesFrom**(view, offset?, length?): [Buffer](../index.md#buffer)` @@ -659,7 +659,7 @@ console.log(buf[0]); // 255 console.log(buf[1]); // 255 ``` -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -713,7 +713,7 @@ v19.8.0 ___ -### from +#### from `**from**(arrayBuffer, byteOffset?, length?): [Buffer](../index.md#buffer)` @@ -736,7 +736,7 @@ appropriate for `Buffer.from()` variants. `Buffer.from(array)` and `Buffer.from(string)` may also use the internal`Buffer` pool like `Buffer.allocUnsafe()` does. -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -792,7 +792,7 @@ v5.10.0 Creates a new Buffer using the passed {data} -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -824,7 +824,7 @@ Creates a new Buffer using the passed {data} `**from**(data): [Buffer](../index.md#buffer)` -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -860,7 +860,7 @@ Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'. -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) @@ -901,7 +901,7 @@ If not provided, {encoding} defaults to 'utf8'. ___ -### isBuffer +#### isBuffer `**isBuffer**(obj): obj is Buffer` @@ -917,7 +917,7 @@ Buffer.isBuffer([]); // false Buffer.isBuffer(new Uint8Array(1024)); // false ``` -#### Parameters +##### Parameters -#### Returns +##### Returns obj is Buffer @@ -953,7 +953,7 @@ v0.1.101 ___ -### isEncoding +#### isEncoding `**isEncoding**(encoding): encoding is BufferEncoding` @@ -976,7 +976,7 @@ console.log(Buffer.isEncoding('')); // Prints: false ``` -#### Parameters +##### Parameters -#### Returns +##### Returns encoding is BufferEncoding @@ -1012,13 +1012,13 @@ v0.9.1 ___ -### of +#### of `**of**(...items): [Buffer](../index.md#buffer)` Creates a new Buffer using the passed {data} -#### Parameters +##### Parameters -#### Returns +##### Returns [Buffer](../index.md#buffer) diff --git a/www/apps/docs/content/references/services/interfaces/CalculatedPriceSet.mdx b/www/apps/docs/content/references/services/interfaces/CalculatedPriceSet.mdx new file mode 100644 index 0000000000..f2b75d425d --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/CalculatedPriceSet.mdx @@ -0,0 +1,176 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CalculatedPriceSet + +The calculated price for a specific price set and context. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/CalculatedPriceSetDTO.mdx b/www/apps/docs/content/references/services/interfaces/CalculatedPriceSetDTO.mdx deleted file mode 100644 index 30b397019a..0000000000 --- a/www/apps/docs/content/references/services/interfaces/CalculatedPriceSetDTO.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -displayed_sidebar: servicesSidebar ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CalculatedPriceSetDTO - -A calculated price set's data. - -## Properties - - diff --git a/www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx b/www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx index 6369db3cf9..5dc0024dc6 100644 --- a/www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx @@ -7,4 +7,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreatePriceListRules The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value - * is the values of the rule. +is the values of the rule. diff --git a/www/apps/docs/content/references/services/interfaces/FindConfig-1.mdx b/www/apps/docs/content/references/services/interfaces/FindConfig-1.mdx index 0e64eb2cb2..f484d037f3 100644 --- a/www/apps/docs/content/references/services/interfaces/FindConfig-1.mdx +++ b/www/apps/docs/content/references/services/interfaces/FindConfig-1.mdx @@ -55,7 +55,7 @@ which provides correct typing of field names in its properties. }, { "name": "skip", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to skip before retrieving the results.", "optional": true, "defaultValue": "", @@ -64,7 +64,7 @@ which provides correct typing of field names in its properties. }, { "name": "take", - "type": "`number`", + "type": "`null` \\| `number`", "description": "A number indicating the number of records to return in the result.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/interfaces/IBatchJobStrategy.mdx b/www/apps/docs/content/references/services/interfaces/IBatchJobStrategy.mdx index 2816424928..a7f58a902c 100644 --- a/www/apps/docs/content/references/services/interfaces/IBatchJobStrategy.mdx +++ b/www/apps/docs/content/references/services/interfaces/IBatchJobStrategy.mdx @@ -58,29 +58,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Accessors -### activeManager\_ +#### activeManager\_ -`Protected get**activeManager_**(): EntityManager` - -#### Returns - -EntityManager - - + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -88,6 +72,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -159,13 +145,13 @@ Promise<TResult> ___ -### buildTemplate +#### buildTemplate `**buildTemplate**(): Promise<string>` Builds and returns a template file that can be downloaded and filled in -#### Returns +##### Returns Promise<string> @@ -183,13 +169,13 @@ Promise<string> ___ -### preProcessBatchJob +#### preProcessBatchJob `**preProcessBatchJob**(batchJobId): Promise<void>` Method for pre-processing a batch job -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -221,13 +207,13 @@ Promise<void> ___ -### prepareBatchJobForProcessing +#### prepareBatchJobForProcessing `**prepareBatchJobForProcessing**(batchJobEntity, req): Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)>` Method for preparing a batch job for processing -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)> @@ -268,13 +254,13 @@ Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)> ___ -### processJob +#### processJob `**processJob**(batchJobId): Promise<void>` Method does the actual processing of the job. Should report back on the progress of the operation. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -306,11 +292,11 @@ Promise<void> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -342,11 +328,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [IBatchJobStrategy](IBatchJobStrategy.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IBatchJobStrategy](IBatchJobStrategy.mdx) diff --git a/www/apps/docs/content/references/services/interfaces/ICacheService.mdx b/www/apps/docs/content/references/services/interfaces/ICacheService.mdx index d08715d8fd..a0912ec28b 100644 --- a/www/apps/docs/content/references/services/interfaces/ICacheService.mdx +++ b/www/apps/docs/content/references/services/interfaces/ICacheService.mdx @@ -8,10 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### get +#### get `**get**(key): Promise<null \| T>` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<null \| T> @@ -56,11 +58,11 @@ Promise<null \| T> ___ -### invalidate +#### invalidate `**invalidate**(key): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -92,11 +94,11 @@ Promise<void> ___ -### set +#### set `**set**(key, data, ttl?): Promise<void>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> diff --git a/www/apps/docs/content/references/services/interfaces/IEventBusModuleService.mdx b/www/apps/docs/content/references/services/interfaces/IEventBusModuleService.mdx index a92de84dca..068337cd1c 100644 --- a/www/apps/docs/content/references/services/interfaces/IEventBusModuleService.mdx +++ b/www/apps/docs/content/references/services/interfaces/IEventBusModuleService.mdx @@ -8,10 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### emit +#### emit `**emit**(eventName, data, options?): Promise<void>` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -74,6 +76,8 @@ Promise<void> `**emit**(data): Promise<void>` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -118,11 +122,11 @@ Promise<void> ___ -### subscribe +#### subscribe `**subscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IEventBusModuleService](IEventBusModuleService.mdx) @@ -172,11 +176,11 @@ ___ ___ -### unsubscribe +#### unsubscribe `**unsubscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IEventBusModuleService](IEventBusModuleService.mdx) diff --git a/www/apps/docs/content/references/services/interfaces/IEventBusService.mdx b/www/apps/docs/content/references/services/interfaces/IEventBusService.mdx index 6d4f292811..6b762829b6 100644 --- a/www/apps/docs/content/references/services/interfaces/IEventBusService.mdx +++ b/www/apps/docs/content/references/services/interfaces/IEventBusService.mdx @@ -8,10 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### emit +#### emit `**emit**(event, data, options?): Promise<unknown>` +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<unknown> @@ -74,11 +76,11 @@ Promise<unknown> ___ -### subscribe +#### subscribe `**subscribe**(eventName, subscriber, context?): [IEventBusService](IEventBusService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IEventBusService](IEventBusService.mdx) @@ -128,11 +130,11 @@ ___ ___ -### unsubscribe +#### unsubscribe `**unsubscribe**(eventName, subscriber, context?): [IEventBusService](IEventBusService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IEventBusService](IEventBusService.mdx) @@ -182,11 +184,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [IEventBusService](IEventBusService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IEventBusService](IEventBusService.mdx) diff --git a/www/apps/docs/content/references/services/interfaces/IInventoryService.mdx b/www/apps/docs/content/references/services/interfaces/IInventoryService.mdx index 6885974bfb..042887c7c2 100644 --- a/www/apps/docs/content/references/services/interfaces/IInventoryService.mdx +++ b/www/apps/docs/content/references/services/interfaces/IInventoryService.mdx @@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### adjustInventory +#### adjustInventory `**adjustInventory**(inventoryItemId, locationId, adjustment, context?): Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>` This method is used to adjust the inventory level's stocked quantity. The inventory level is identified by the IDs of its associated inventory item and location. -#### Example +##### Example ```ts import { @@ -38,7 +38,7 @@ async function adjustInventory ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> @@ -97,13 +97,13 @@ Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> ___ -### confirmInventory +#### confirmInventory `**confirmInventory**(inventoryItemId, locationIds, quantity, context?): Promise<boolean>` This method is used to confirm whether the specified quantity of an inventory item is available in the specified locations. -#### Example +##### Example ```ts import { @@ -125,7 +125,7 @@ async function confirmInventory ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<boolean> @@ -184,13 +184,13 @@ Promise<boolean> ___ -### createInventoryItem +#### createInventoryItem `**createInventoryItem**(input, context?): Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>` This method is used to create an inventory item. -#### Example +##### Example ```ts import { @@ -211,7 +211,7 @@ async function createInventoryItem (item: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)> @@ -252,13 +252,13 @@ Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)> ___ -### createInventoryItems +#### createInventoryItems `**createInventoryItems**(input, context?): Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>` This method is used to create inventory items. -#### Example +##### Example ```ts import { @@ -279,7 +279,7 @@ async function createInventoryItems (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]> @@ -320,13 +320,13 @@ Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]> ___ -### createInventoryLevel +#### createInventoryLevel `**createInventoryLevel**(data, context?): Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>` This method is used to create inventory level. -#### Example +##### Example ```ts import { @@ -348,7 +348,7 @@ async function createInventoryLevel (item: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> @@ -389,13 +389,13 @@ Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> ___ -### createInventoryLevels +#### createInventoryLevels `**createInventoryLevels**(data, context?): Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>` This method is used to create inventory levels. -#### Example +##### Example ```ts import { @@ -417,7 +417,7 @@ async function createInventoryLevels (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]> @@ -458,13 +458,13 @@ Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]> ___ -### createReservationItem +#### createReservationItem `**createReservationItem**(input, context?): Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>` This method is used to create a reservation item. -#### Example +##### Example ```ts import { @@ -486,7 +486,7 @@ async function createReservationItem (item: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)> @@ -527,13 +527,13 @@ Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)> ___ -### createReservationItems +#### createReservationItems `**createReservationItems**(input, context?): Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>` This method is used to create reservation items. -#### Example +##### Example ```ts import { @@ -555,7 +555,7 @@ async function createReservationItems (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]> @@ -596,14 +596,14 @@ Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]> ___ -### deleteInventoryItem +#### deleteInventoryItem `**deleteInventoryItem**(inventoryItemId, context?): Promise<void>` 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](IInventoryService.mdx#restoreinventoryitem) method. -#### Example +##### Example ```ts import { @@ -621,7 +621,7 @@ async function deleteInventoryItem ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -662,13 +662,13 @@ Promise<void> ___ -### deleteInventoryItemLevelByLocationId +#### deleteInventoryItemLevelByLocationId `**deleteInventoryItemLevelByLocationId**(locationId, context?): Promise<void>` This method deletes the inventory item level(s) for the ID(s) of associated location(s). -#### Example +##### Example ```ts import { @@ -686,7 +686,7 @@ async function deleteInventoryItemLevelByLocationId ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -727,13 +727,13 @@ Promise<void> ___ -### deleteInventoryLevel +#### deleteInventoryLevel `**deleteInventoryLevel**(inventoryItemId, locationId, context?): Promise<void>` This method is used to delete an inventory level. The inventory level is identified by the IDs of its associated inventory item and location. -#### Example +##### Example ```ts import { @@ -753,7 +753,7 @@ async function deleteInventoryLevel ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -803,13 +803,13 @@ Promise<void> ___ -### deleteReservationItem +#### deleteReservationItem `**deleteReservationItem**(reservationItemId, context?): Promise<void>` This method is used to delete a reservation item or multiple reservation items by their IDs. -#### Example +##### Example ```ts import { @@ -827,7 +827,7 @@ async function deleteReservationItems ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -868,13 +868,13 @@ Promise<void> ___ -### deleteReservationItemByLocationId +#### deleteReservationItemByLocationId `**deleteReservationItemByLocationId**(locationId, context?): Promise<void>` This method deletes reservation item(s) by the ID(s) of associated location(s). -#### Example +##### Example ```ts import { @@ -892,7 +892,7 @@ async function deleteReservationItemByLocationId ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -933,13 +933,13 @@ Promise<void> ___ -### deleteReservationItemsByLineItem +#### deleteReservationItemsByLineItem `**deleteReservationItemsByLineItem**(lineItemId, context?): Promise<void>` This method is used to delete the reservation items associated with a line item or multiple line items. -#### Example +##### Example ```ts import { @@ -957,7 +957,7 @@ async function deleteReservationItemsByLineItem ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -998,13 +998,13 @@ Promise<void> ___ -### listInventoryItems +#### listInventoryItems `**listInventoryItems**(selector, config?, context?): Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]>` 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: @@ -1066,7 +1066,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]> @@ -1116,13 +1116,13 @@ Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]> ___ -### listInventoryLevels +#### listInventoryLevels `**listInventoryLevels**(selector, config?, context?): Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]>` 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: @@ -1184,7 +1184,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]> @@ -1234,13 +1234,13 @@ Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]> ___ -### listReservationItems +#### listReservationItems `**listReservationItems**(selector, config?, context?): Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]>` 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: @@ -1302,7 +1302,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]> @@ -1352,13 +1352,13 @@ Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number] ___ -### restoreInventoryItem +#### restoreInventoryItem `**restoreInventoryItem**(inventoryItemId, context?): Promise<void>` This method is used to restore an inventory item or multiple inventory items that were previously deleted using the [deleteInventoryItem](IInventoryService.mdx#deleteinventoryitem) method. -#### Example +##### Example ```ts import { @@ -1376,7 +1376,7 @@ async function restoreInventoryItem ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1417,13 +1417,13 @@ Promise<void> ___ -### retrieveAvailableQuantity +#### retrieveAvailableQuantity `**retrieveAvailableQuantity**(inventoryItemId, locationIds, context?): Promise<number>` This method is used to retrieve the available quantity of an inventory item within the specified locations. -#### Example +##### Example ```ts import { @@ -1445,7 +1445,7 @@ async function retrieveAvailableQuantity ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1495,13 +1495,13 @@ Promise<number> ___ -### retrieveInventoryItem +#### retrieveInventoryItem `**retrieveInventoryItem**(inventoryItemId, config?, context?): Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>` 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: @@ -1537,7 +1537,7 @@ async function retrieveInventoryItem (id: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)> @@ -1587,13 +1587,13 @@ Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)> ___ -### retrieveInventoryLevel +#### retrieveInventoryLevel `**retrieveInventoryLevel**(inventoryItemId, locationId, context?): Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>` This method is used to retrieve an inventory level for an inventory item and a location. -#### Example +##### Example ```ts import { @@ -1615,7 +1615,7 @@ async function retrieveInventoryLevel ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> @@ -1665,13 +1665,13 @@ Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> ___ -### retrieveReservationItem +#### retrieveReservationItem `**retrieveReservationItem**(reservationId, context?): Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>` This method is used to retrieve a reservation item by its ID. -#### Example +##### Example ```ts import { @@ -1687,7 +1687,7 @@ async function retrieveReservationItem (id: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)> @@ -1728,13 +1728,13 @@ Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)> ___ -### retrieveReservedQuantity +#### retrieveReservedQuantity `**retrieveReservedQuantity**(inventoryItemId, locationIds, context?): Promise<number>` This method is used to retrieve the reserved quantity of an inventory item within the specified locations. -#### Example +##### Example ```ts import { @@ -1756,7 +1756,7 @@ async function retrieveReservedQuantity ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1806,13 +1806,13 @@ Promise<number> ___ -### retrieveStockedQuantity +#### retrieveStockedQuantity `**retrieveStockedQuantity**(inventoryItemId, locationIds, context?): Promise<number>` This method is used to retrieve the stocked quantity of an inventory item within the specified locations. -#### Example +##### Example ```ts import { @@ -1834,7 +1834,7 @@ async function retrieveStockedQuantity ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> @@ -1884,13 +1884,13 @@ Promise<number> ___ -### updateInventoryItem +#### updateInventoryItem `**updateInventoryItem**(inventoryItemId, input, context?): Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>` This method is used to update an inventory item. -#### Example +##### Example ```ts import { @@ -1914,7 +1914,7 @@ async function updateInventoryItem ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)> @@ -1964,13 +1964,13 @@ Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)> ___ -### updateInventoryLevel +#### updateInventoryLevel `**updateInventoryLevel**(inventoryItemId, locationId, update, context?): Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>` This method is used to update an inventory level. The inventory level is identified by the IDs of its associated inventory item and location. -#### Example +##### Example ```ts import { @@ -1996,7 +1996,7 @@ async function updateInventoryLevel ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> @@ -2055,13 +2055,13 @@ Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)> ___ -### updateInventoryLevels +#### updateInventoryLevels `**updateInventoryLevels**(updates, context?): Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>` This method is used to update inventory levels. Each inventory level is identified by the IDs of its associated inventory item and location. -#### Example +##### Example ```ts import { @@ -2083,7 +2083,7 @@ async function updateInventoryLevels (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]> @@ -2124,13 +2124,13 @@ Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]> ___ -### updateReservationItem +#### updateReservationItem `**updateReservationItem**(reservationItemId, input, context?): Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>` This method is used to update a reservation item. -#### Example +##### Example ```ts import { @@ -2154,7 +2154,7 @@ async function updateReservationItem ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)> diff --git a/www/apps/docs/content/references/services/interfaces/INotificationService.mdx b/www/apps/docs/content/references/services/interfaces/INotificationService.mdx index 6bb1842413..8a97bdac99 100644 --- a/www/apps/docs/content/references/services/interfaces/INotificationService.mdx +++ b/www/apps/docs/content/references/services/interfaces/INotificationService.mdx @@ -58,29 +58,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Accessors -### activeManager\_ +#### activeManager\_ -`Protected get**activeManager_**(): EntityManager` - -#### Returns - -EntityManager - - + `Protected` **activeManager\_**: [object Object] ## Methods -### atomicPhase\_ +#### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` @@ -88,6 +72,8 @@ Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created. +##### Type Parameters + -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<TResult> @@ -159,11 +145,11 @@ Promise<TResult> ___ -### resendNotification +#### resendNotification `**resendNotification**(notification, config, attachmentGenerator): Promise<[ReturnedData](../types/ReturnedData.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnedData](../types/ReturnedData.mdx)> @@ -213,11 +199,11 @@ Promise<[ReturnedData](../types/ReturnedData.mdx)> ___ -### sendNotification +#### sendNotification `**sendNotification**(event, data, attachmentGenerator): Promise<[ReturnedData](../types/ReturnedData.mdx)>` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ReturnedData](../types/ReturnedData.mdx)> @@ -267,11 +253,11 @@ Promise<[ReturnedData](../types/ReturnedData.mdx)> ___ -### shouldRetryTransaction\_ +#### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` -#### Parameters +##### Parameters -#### Returns +##### Returns `boolean` @@ -303,11 +289,11 @@ ___ ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [INotificationService](INotificationService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [INotificationService](INotificationService.mdx) diff --git a/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx b/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx index 7398c36935..cdc977cc88 100644 --- a/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx +++ b/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx @@ -8,14 +8,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### calculateVariantPrice +#### calculateVariantPrice `**calculateVariantPrice**(data, context): Promise<Map<string, [PriceSelectionResult](../types/PriceSelectionResult.mdx)>>` Calculate the original and discount price for a given variant in a set of circumstances described in the context. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Map<string, [PriceSelectionResult](../types/PriceSelectionResult.mdx)>> @@ -56,13 +56,13 @@ Promise<Map<string, [PriceSelectionResult](../types/PriceSelectionResult ___ -### onVariantsPricesUpdate +#### onVariantsPricesUpdate `**onVariantsPricesUpdate**(variantIds): Promise<void>` Notify price selection strategy that variants prices have been updated. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -94,11 +94,11 @@ Promise<void> ___ -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [IPriceSelectionStrategy](IPriceSelectionStrategy.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [IPriceSelectionStrategy](IPriceSelectionStrategy.mdx) diff --git a/www/apps/docs/content/references/services/interfaces/IPricingModuleService.mdx b/www/apps/docs/content/references/services/interfaces/IPricingModuleService.mdx index a838a42a9e..bba08db426 100644 --- a/www/apps/docs/content/references/services/interfaces/IPricingModuleService.mdx +++ b/www/apps/docs/content/references/services/interfaces/IPricingModuleService.mdx @@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### addPriceListPrices +#### addPriceListPrices `**addPriceListPrices**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)[]>` This method is used to add prices to price lists. -#### Example +##### Example ```ts import { @@ -37,7 +37,7 @@ async function addPriceListPrices (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListDTO](PriceListDTO.mdx)[]> @@ -78,13 +78,13 @@ Promise<[PriceListDTO](PriceListDTO.mdx)[]> ___ -### addPrices +#### addPrices `**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](PriceSetDTO.mdx)>` This method adds prices to a price set. -#### Example +##### Example To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`: @@ -155,7 +155,7 @@ async function addPricesToPriceSet (priceSetId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)> @@ -198,7 +198,7 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)> This method adds prices to multiple price sets. -#### Example +##### Example To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`: @@ -269,7 +269,7 @@ async function addPricesToPriceSet (priceSetId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> @@ -310,13 +310,13 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> ___ -### addRules +#### addRules `**addRules**(data, sharedContext?): Promise<[PriceSetDTO](PriceSetDTO.mdx)>` This method adds rules to a price set. -#### Example +##### Example ```ts import { @@ -337,7 +337,7 @@ async function addRulesToPriceSet (priceSetId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)> @@ -380,7 +380,7 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)> This method adds rules to multiple price sets. -#### Example +##### Example ```ts import { @@ -401,7 +401,7 @@ async function addRulesToPriceSet (priceSetId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> @@ -442,13 +442,13 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> ___ -### calculatePrices +#### calculatePrices -`**calculatePrices**(filters, context?, sharedContext?): Promise<[CalculatedPriceSetDTO](CalculatedPriceSetDTO.mdx)>` +`**calculatePrices**(filters, context?, sharedContext?): Promise<[CalculatedPriceSet](CalculatedPriceSet.mdx)[]>` This method is used to calculate prices based on the provided filters and context. -#### Example +##### Example When you calculate prices, you must at least specify the currency code: @@ -518,7 +518,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns -Promise<[CalculatedPriceSetDTO](CalculatedPriceSetDTO.mdx)> +Promise<[CalculatedPriceSet](CalculatedPriceSet.mdx)[]> -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)> @@ -691,7 +691,7 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)> This method is used to create multiple price sets. -#### Example +##### Example To create price sets with a default price, don't pass any rules and make sure to pass the `currency_code` of the price. For example: @@ -762,7 +762,7 @@ async function createPriceSets() { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> @@ -803,13 +803,13 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> ___ -### createCurrencies +#### createCurrencies `**createCurrencies**(data, sharedContext?): Promise<[CurrencyDTO](CurrencyDTO.mdx)[]>` This method is used to create new currencies. -#### Example +##### Example ```ts import { initialize as initializePricingModule } from "@medusajs/pricing" @@ -830,7 +830,7 @@ async function createCurrencies() { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CurrencyDTO](CurrencyDTO.mdx)[]> @@ -871,13 +871,13 @@ Promise<[CurrencyDTO](CurrencyDTO.mdx)[]> ___ -### createMoneyAmounts +#### createMoneyAmounts `**createMoneyAmounts**(data, sharedContext?): Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]>` This method creates money amounts. -#### Example +##### Example ```ts import { initialize as initializePricingModule } from "@medusajs/pricing" @@ -902,7 +902,7 @@ async function retrieveMoneyAmounts() { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> @@ -943,13 +943,13 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> ___ -### createPriceListRules +#### createPriceListRules `**createPriceListRules**(data, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]>` This method is used to create price list rules. -#### Example +##### Example ```ts import { @@ -968,7 +968,7 @@ async function createPriceListRules (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> @@ -1009,13 +1009,13 @@ Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> ___ -### createPriceLists +#### createPriceLists `**createPriceLists**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)[]>` This method is used to create price lists. -#### Example +##### Example ```ts import { @@ -1036,7 +1036,7 @@ async function createPriceList (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListDTO](PriceListDTO.mdx)[]> @@ -1077,13 +1077,13 @@ Promise<[PriceListDTO](PriceListDTO.mdx)[]> ___ -### createPriceRules +#### createPriceRules `**createPriceRules**(data, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]>` This method is used to create new price rules based on the provided data. -#### Example +##### Example ```ts import { @@ -1115,7 +1115,7 @@ async function createPriceRules ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]> @@ -1156,14 +1156,14 @@ Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]> ___ -### createPriceSetMoneyAmountRules +#### createPriceSetMoneyAmountRules `**createPriceSetMoneyAmountRules**(data, sharedContext?): Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]>` This method is used to create new price set money amount rules. A price set money amount rule creates an association between a price set money amount and a rule type. -#### Example +##### Example ```ts import { @@ -1185,7 +1185,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]> @@ -1226,13 +1226,13 @@ Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]> ___ -### createRuleTypes +#### createRuleTypes `**createRuleTypes**(data, sharedContext?): Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]>` This method is used to create new rule types. -#### Example +##### Example ```ts import { initialize as initializePricingModule } from "@medusajs/pricing" @@ -1251,7 +1251,7 @@ async function createRuleTypes() { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]> @@ -1292,13 +1292,13 @@ Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]> ___ -### delete +#### delete `**delete**(ids, sharedContext?): Promise<void>` This method deletes price sets by their IDs. -#### Example +##### Example ```ts import { @@ -1312,7 +1312,7 @@ async function removePriceSetRule (priceSetIds: string[]) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1353,13 +1353,13 @@ Promise<void> ___ -### deleteCurrencies +#### deleteCurrencies `**deleteCurrencies**(currencyCodes, sharedContext?): Promise<void>` This method is used to delete currencies based on their currency code. -#### Example +##### Example ```ts import { initialize as initializePricingModule } from "@medusajs/pricing" @@ -1371,7 +1371,7 @@ async function deleteCurrencies() { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1412,13 +1412,13 @@ Promise<void> ___ -### deleteMoneyAmounts +#### deleteMoneyAmounts `**deleteMoneyAmounts**(ids, sharedContext?): Promise<void>` This method deletes money amounts by their IDs. -#### Example +##### Example ```ts import { @@ -1434,7 +1434,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1475,13 +1475,13 @@ Promise<void> ___ -### deletePriceListRules +#### deletePriceListRules `**deletePriceListRules**(priceListRuleIds, sharedContext?): Promise<void>` This method is used to delete price list rules. -#### Example +##### Example ```ts import { @@ -1495,7 +1495,7 @@ async function deletePriceListRules (priceListRuleIds: string[]) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1536,13 +1536,13 @@ Promise<void> ___ -### deletePriceLists +#### deletePriceLists `**deletePriceLists**(priceListIds, sharedContext?): Promise<void>` This method is used to delete price lists. -#### Example +##### Example ```ts import { @@ -1556,7 +1556,7 @@ async function deletePriceLists (ids: string[]) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1597,13 +1597,13 @@ Promise<void> ___ -### deletePriceRules +#### deletePriceRules `**deletePriceRules**(priceRuleIds, sharedContext?): Promise<void>` This method is used to delete price rules based on the specified IDs. -#### Example +##### Example ```ts import { @@ -1619,7 +1619,7 @@ async function deletePriceRules ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1660,13 +1660,13 @@ Promise<void> ___ -### deletePriceSetMoneyAmountRules +#### deletePriceSetMoneyAmountRules `**deletePriceSetMoneyAmountRules**(ids, sharedContext?): Promise<void>` This method is used to delete price set money amount rules based on the specified IDs. -#### Example +##### Example ```ts import { @@ -1680,7 +1680,7 @@ async function deletePriceSetMoneyAmountRule (id: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1721,13 +1721,13 @@ Promise<void> ___ -### deleteRuleTypes +#### deleteRuleTypes `**deleteRuleTypes**(ruleTypeIds, sharedContext?): Promise<void>` This method is used to delete rule types based on the provided IDs. -#### Example +##### Example ```ts import { @@ -1741,7 +1741,7 @@ async function deleteRuleTypes (ruleTypeId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -1782,13 +1782,13 @@ Promise<void> ___ -### list +#### list `**list**(filters?, config?, sharedContext?): Promise<[PriceSetDTO](PriceSetDTO.mdx)[]>` This method is used to retrieve a paginated list of price sets based on optional filters and configuration. -#### Example +##### Example To retrieve a list of price sets using their IDs: @@ -1892,7 +1892,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> @@ -1942,13 +1942,13 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(filters?, config?, sharedContext?): Promise<[[PriceSetDTO](PriceSetDTO.mdx)[], number]>` This method is used to retrieve a paginated list of price sets along with the total count of available price sets satisfying the provided filters. -#### Example +##### Example To retrieve a list of prices sets using their IDs: @@ -2052,7 +2052,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[PriceSetDTO](PriceSetDTO.mdx)[], number]> @@ -2102,13 +2102,13 @@ Promise<[[PriceSetDTO](PriceSetDTO.mdx)[], number]> ___ -### listAndCountCurrencies +#### listAndCountCurrencies `**listAndCountCurrencies**(filters?, config?, sharedContext?): Promise<[[CurrencyDTO](CurrencyDTO.mdx)[], number]>` This method is used to retrieve a paginated list of currencies along with the total count of available currencies satisfying the provided filters. -#### Example +##### Example To retrieve a list of currencies using their codes: @@ -2178,7 +2178,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[CurrencyDTO](CurrencyDTO.mdx)[], number]> @@ -2228,13 +2228,13 @@ Promise<[[CurrencyDTO](CurrencyDTO.mdx)[], number]> ___ -### listAndCountMoneyAmounts +#### listAndCountMoneyAmounts `**listAndCountMoneyAmounts**(filters?, config?, sharedContext?): Promise<[[MoneyAmountDTO](MoneyAmountDTO.mdx)[], number]>` This method is used to retrieve a paginated list of money amounts along with the total count of available money amounts satisfying the provided filters. -#### Example +##### Example To retrieve a list of money amounts using their IDs: @@ -2336,7 +2336,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[MoneyAmountDTO](MoneyAmountDTO.mdx)[], number]> @@ -2386,13 +2386,13 @@ Promise<[[MoneyAmountDTO](MoneyAmountDTO.mdx)[], number]> ___ -### listAndCountPriceListRules +#### listAndCountPriceListRules `**listAndCountPriceListRules**(filters?, config?, sharedContext?): Promise<[[PriceListRuleDTO](PriceListRuleDTO.mdx)[], number]>` This method is used to retrieve a paginated list of price list ruless along with the total count of available price list ruless satisfying the provided filters. -#### Example +##### Example To retrieve a list of price list vs using their IDs: @@ -2494,7 +2494,7 @@ async function listAndCountPriceListRules (priceListRuleIds: string[], ruleTypeI } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[PriceListRuleDTO](PriceListRuleDTO.mdx)[], number]> @@ -2544,13 +2544,13 @@ Promise<[[PriceListRuleDTO](PriceListRuleDTO.mdx)[], number]> ___ -### listAndCountPriceLists +#### listAndCountPriceLists `**listAndCountPriceLists**(filters?, config?, sharedContext?): Promise<[[PriceListDTO](PriceListDTO.mdx)[], number]>` This method is used to retrieve a paginated list of price lists along with the total count of available price lists satisfying the provided filters. -#### Example +##### Example To retrieve a list of price lists using their IDs: @@ -2652,7 +2652,7 @@ async function retrievePriceLists (priceListIds: string[], titles: string[], ski } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[PriceListDTO](PriceListDTO.mdx)[], number]> @@ -2702,13 +2702,13 @@ Promise<[[PriceListDTO](PriceListDTO.mdx)[], number]> ___ -### listAndCountPriceRules +#### listAndCountPriceRules `**listAndCountPriceRules**(filters?, config?, sharedContext?): Promise<[[PriceRuleDTO](PriceRuleDTO.mdx)[], number]>` This method is used to retrieve a paginated list of price rules along with the total count of available price rules satisfying the provided filters. -#### Example +##### Example To retrieve a list of price rules using their IDs: @@ -2799,7 +2799,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[PriceRuleDTO](PriceRuleDTO.mdx)[], number]> @@ -2849,14 +2849,14 @@ Promise<[[PriceRuleDTO](PriceRuleDTO.mdx)[], number]> ___ -### listAndCountPriceSetMoneyAmountRules +#### listAndCountPriceSetMoneyAmountRules `**listAndCountPriceSetMoneyAmountRules**(filters?, config?, sharedContext?): Promise<[[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[], number]>` This method is used to retrieve a paginated list of price set money amount rules along with the total count of available price set money amount rules satisfying the provided filters. -#### Example +##### Example To retrieve a list of price set money amounts using their IDs: @@ -2947,7 +2947,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[], number]> @@ -2997,14 +2997,14 @@ Promise<[[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[], n ___ -### listAndCountPriceSetMoneyAmounts +#### listAndCountPriceSetMoneyAmounts `**listAndCountPriceSetMoneyAmounts**(filters?, config?, sharedContext?): Promise<[[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[], number]>` This method is used to retrieve a paginated list of price set money amounts along with the total count of available price set money amounts satisfying the provided filters. -#### Example +##### Example To retrieve a list of price set money amounts using their IDs: @@ -3095,7 +3095,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[], number]> @@ -3145,13 +3145,13 @@ Promise<[[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[], number]> ___ -### listAndCountRuleTypes +#### listAndCountRuleTypes `**listAndCountRuleTypes**(filters?, config?, sharedContext?): Promise<[[RuleTypeDTO](RuleTypeDTO.mdx)[], number]>` This method is used to retrieve a paginated list of rule types along with the total count of available rule types satisfying the provided filters. -#### Example +##### Example To retrieve a list of rule types using their IDs: @@ -3248,7 +3248,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[RuleTypeDTO](RuleTypeDTO.mdx)[], number]> @@ -3298,13 +3298,13 @@ Promise<[[RuleTypeDTO](RuleTypeDTO.mdx)[], number]> ___ -### listCurrencies +#### listCurrencies `**listCurrencies**(filters?, config?, sharedContext?): Promise<[CurrencyDTO](CurrencyDTO.mdx)[]>` This method is used to retrieve a paginated list of currencies based on optional filters and configuration. -#### Example +##### Example To retrieve a list of currencies using their codes: @@ -3374,7 +3374,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CurrencyDTO](CurrencyDTO.mdx)[]> @@ -3424,13 +3424,13 @@ Promise<[CurrencyDTO](CurrencyDTO.mdx)[]> ___ -### listMoneyAmounts +#### listMoneyAmounts `**listMoneyAmounts**(filters?, config?, sharedContext?): Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]>` This method is used to retrieve a paginated list of money amounts based on optional filters and configuration. -#### Example +##### Example To retrieve a list of money amounts using their IDs: @@ -3532,7 +3532,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> @@ -3582,13 +3582,13 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> ___ -### listPriceListRules +#### listPriceListRules `**listPriceListRules**(filters?, config?, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]>` This method is used to retrieve a paginated list of price list rules based on optional filters and configuration. -#### Example +##### Example To retrieve a list of price list vs using their IDs: @@ -3690,7 +3690,7 @@ async function listPriceListRules (priceListRuleIds: string[], ruleTypeIDs: stri } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> @@ -3740,13 +3740,13 @@ Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> ___ -### listPriceLists +#### listPriceLists `**listPriceLists**(filters?, config?, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)[]>` This method is used to retrieve a paginated list of price lists based on optional filters and configuration. -#### Example +##### Example To retrieve a list of price lists using their IDs: @@ -3848,7 +3848,7 @@ async function listPriceLists (priceListIds: string[], titles: string[], skip: n } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListDTO](PriceListDTO.mdx)[]> @@ -3898,13 +3898,13 @@ Promise<[PriceListDTO](PriceListDTO.mdx)[]> ___ -### listPriceRules +#### listPriceRules `**listPriceRules**(filters?, config?, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]>` This method is used to retrieve a paginated list of price rules based on optional filters and configuration. -#### Example +##### Example To retrieve a list of price rules using their IDs: @@ -3995,7 +3995,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]> @@ -4045,13 +4045,13 @@ Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]> ___ -### listPriceSetMoneyAmountRules +#### listPriceSetMoneyAmountRules `**listPriceSetMoneyAmountRules**(filters?, config?, sharedContext?): Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]>` This method is used to retrieve a paginated list of price set money amount rules based on optional filters and configuration. -#### Example +##### Example To retrieve a list of price set money amount rules using their IDs: @@ -4142,7 +4142,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]> @@ -4192,13 +4192,13 @@ Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]> ___ -### listPriceSetMoneyAmounts +#### listPriceSetMoneyAmounts `**listPriceSetMoneyAmounts**(filters?, config?, sharedContext?): Promise<[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]>` This method is used to retrieve a paginated list of price set money amounts based on optional filters and configuration. -#### Example +##### Example To retrieve a list of price set money amounts using their IDs: @@ -4289,7 +4289,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]> @@ -4339,13 +4339,13 @@ Promise<[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]> ___ -### listRuleTypes +#### listRuleTypes `**listRuleTypes**(filters?, config?, sharedContext?): Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]>` This method is used to retrieve a paginated list of rule types based on optional filters and configuration. -#### Example +##### Example To retrieve a list of rule types using their IDs: @@ -4442,7 +4442,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]> @@ -4492,13 +4492,13 @@ Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]> ___ -### removePriceListRules +#### removePriceListRules `**removePriceListRules**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)>` This method is used to remove rules from a price list. -#### Example +##### Example ```ts import { @@ -4517,7 +4517,7 @@ async function setPriceListRules (priceListId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListDTO](PriceListDTO.mdx)> @@ -4558,13 +4558,13 @@ Promise<[PriceListDTO](PriceListDTO.mdx)> ___ -### removeRules +#### removeRules `**removeRules**(data, sharedContext?): Promise<void>` This method remove rules from a price set. -#### Example +##### Example ```ts import { @@ -4583,7 +4583,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -4624,13 +4624,13 @@ Promise<void> ___ -### retrieve +#### retrieve `**retrieve**(id, config?, sharedContext?): Promise<[PriceSetDTO](PriceSetDTO.mdx)>` This method is used to retrieve a price set by its ID. -#### Example +##### Example A simple example that retrieves a price set by its ID: @@ -4671,7 +4671,7 @@ async function retrievePriceSet (priceSetId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetDTO](PriceSetDTO.mdx)> @@ -4721,13 +4721,13 @@ Promise<[PriceSetDTO](PriceSetDTO.mdx)> ___ -### retrieveCurrency +#### retrieveCurrency `**retrieveCurrency**(code, config?, sharedContext?): Promise<[CurrencyDTO](CurrencyDTO.mdx)>` This method retrieves a currency by its code and and optionally based on the provided configurations. -#### Example +##### Example A simple example that retrieves a currency by its code: @@ -4768,7 +4768,7 @@ async function retrieveCurrency (code: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CurrencyDTO](CurrencyDTO.mdx)> @@ -4818,13 +4818,13 @@ Promise<[CurrencyDTO](CurrencyDTO.mdx)> ___ -### retrieveMoneyAmount +#### retrieveMoneyAmount `**retrieveMoneyAmount**(id, config?, sharedContext?): Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)>` This method retrieves a money amount by its ID. -#### Example +##### Example To retrieve a money amount by its ID: @@ -4865,7 +4865,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)> @@ -4915,13 +4915,13 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)> ___ -### retrievePriceList +#### retrievePriceList `**retrievePriceList**(id, config?, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)>` This method is used to retrieve a price list by its ID. -#### Example +##### Example A simple example that retrieves a price list by its ID: @@ -4962,7 +4962,7 @@ async function retrievePriceList (priceListId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListDTO](PriceListDTO.mdx)> @@ -5012,13 +5012,13 @@ Promise<[PriceListDTO](PriceListDTO.mdx)> ___ -### retrievePriceListRule +#### retrievePriceListRule `**retrievePriceListRule**(id, config?, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)>` This method is used to retrieve a price list rule by its ID. -#### Example +##### Example A simple example that retrieves a price list rule by its ID: @@ -5059,7 +5059,7 @@ async function retrievePriceListRule (priceListRuleId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)> @@ -5109,13 +5109,13 @@ Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)> ___ -### retrievePriceRule +#### retrievePriceRule `**retrievePriceRule**(id, config?, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)>` This method is used to retrieve a price rule by its ID. -#### Example +##### Example A simple example that retrieves a price rule by its ID: @@ -5151,7 +5151,7 @@ async function retrievePriceRule (id: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceRuleDTO](PriceRuleDTO.mdx)> @@ -5201,13 +5201,13 @@ Promise<[PriceRuleDTO](PriceRuleDTO.mdx)> ___ -### retrievePriceSetMoneyAmountRules +#### retrievePriceSetMoneyAmountRules `**retrievePriceSetMoneyAmountRules**(id, config?, sharedContext?): Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)>` This method is used to a price set money amount rule by its ID based on the provided configuration. -#### Example +##### Example A simple example that retrieves a price set money amount rule by its ID: @@ -5243,7 +5243,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)> @@ -5293,13 +5293,13 @@ Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)> ___ -### retrieveRuleType +#### retrieveRuleType `**retrieveRuleType**(id, config?, sharedContext?): Promise<[RuleTypeDTO](RuleTypeDTO.mdx)>` This method is used to retrieve a rule type by its ID and and optionally based on the provided configurations. -#### Example +##### Example A simple example that retrieves a rule type by its code: @@ -5335,7 +5335,7 @@ async function retrieveRuleType (ruleTypeId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[RuleTypeDTO](RuleTypeDTO.mdx)> @@ -5385,13 +5385,13 @@ Promise<[RuleTypeDTO](RuleTypeDTO.mdx)> ___ -### setPriceListRules +#### setPriceListRules `**setPriceListRules**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)>` This method is used to set the rules of a price list. -#### Example +##### Example ```ts import { @@ -5412,7 +5412,7 @@ async function setPriceListRules (priceListId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListDTO](PriceListDTO.mdx)> @@ -5453,13 +5453,13 @@ Promise<[PriceListDTO](PriceListDTO.mdx)> ___ -### updateCurrencies +#### updateCurrencies `**updateCurrencies**(data, sharedContext?): Promise<[CurrencyDTO](CurrencyDTO.mdx)[]>` This method is used to update existing currencies with the provided data. In each currency object, the currency code must be provided to identify which currency to update. -#### Example +##### Example ```ts import { initialize as initializePricingModule } from "@medusajs/pricing" @@ -5478,7 +5478,7 @@ async function updateCurrencies() { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[CurrencyDTO](CurrencyDTO.mdx)[]> @@ -5519,13 +5519,13 @@ Promise<[CurrencyDTO](CurrencyDTO.mdx)[]> ___ -### updateMoneyAmounts +#### updateMoneyAmounts `**updateMoneyAmounts**(data, sharedContext?): Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]>` This method updates existing money amounts. -#### Example +##### Example ```ts import { @@ -5546,7 +5546,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> @@ -5587,13 +5587,13 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> ___ -### updatePriceListRules +#### updatePriceListRules `**updatePriceListRules**(data, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]>` This method is used to update price list rules. -#### Example +##### Example ```ts import { @@ -5613,7 +5613,7 @@ async function updatePriceListRules (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> @@ -5654,13 +5654,13 @@ Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> ___ -### updatePriceLists +#### updatePriceLists `**updatePriceLists**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)[]>` This method is used to update price lists. -#### Example +##### Example ```ts import { @@ -5682,7 +5682,7 @@ async function updatePriceLists (items: { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceListDTO](PriceListDTO.mdx)[]> @@ -5723,13 +5723,13 @@ Promise<[PriceListDTO](PriceListDTO.mdx)[]> ___ -### updatePriceRules +#### updatePriceRules `**updatePriceRules**(data, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]>` This method is used to update price rules, each with their provided data. -#### Example +##### Example ```ts import { @@ -5753,7 +5753,7 @@ async function updatePriceRules ( } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]> @@ -5794,13 +5794,13 @@ Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]> ___ -### updatePriceSetMoneyAmountRules +#### updatePriceSetMoneyAmountRules `**updatePriceSetMoneyAmountRules**(data, sharedContext?): Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]>` This method is used to update price set money amount rules, each with their provided data. -#### Example +##### Example ```ts import { @@ -5821,7 +5821,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]> @@ -5862,13 +5862,13 @@ Promise<[PriceSetMoneyAmountRulesDTO](PriceSetMoneyAmountRulesDTO.mdx)[]> ___ -### updateRuleTypes +#### updateRuleTypes `**updateRuleTypes**(data, sharedContext?): Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]>` This method is used to update existing rule types with the provided data. -#### Example +##### Example ```ts import { @@ -5889,7 +5889,7 @@ async function updateRuleTypes (ruleTypeId: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]> diff --git a/www/apps/docs/content/references/services/interfaces/ISearchService.mdx b/www/apps/docs/content/references/services/interfaces/ISearchService.mdx index 67d7056c1b..a45c2e7557 100644 --- a/www/apps/docs/content/references/services/interfaces/ISearchService.mdx +++ b/www/apps/docs/content/references/services/interfaces/ISearchService.mdx @@ -22,13 +22,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### addDocuments +#### addDocuments `**addDocuments**(indexName, documents, type): unknown` Used to index documents by the search engine provider -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -78,13 +78,13 @@ Used to index documents by the search engine provider ___ -### createIndex +#### createIndex `**createIndex**(indexName, options): unknown` Used to create an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -125,13 +125,13 @@ Used to create an index ___ -### deleteAllDocuments +#### deleteAllDocuments `**deleteAllDocuments**(indexName): unknown` Used to delete all documents -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -163,13 +163,13 @@ Used to delete all documents ___ -### deleteDocument +#### deleteDocument `**deleteDocument**(indexName, document_id): unknown` Used to delete document -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -210,13 +210,13 @@ Used to delete document ___ -### getIndex +#### getIndex `**getIndex**(indexName): unknown` Used to get an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -248,13 +248,13 @@ Used to get an index ___ -### replaceDocuments +#### replaceDocuments `**replaceDocuments**(indexName, documents, type): unknown` Used to replace documents -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -304,13 +304,13 @@ Used to replace documents ___ -### search +#### search `**search**(indexName, query, options): unknown` Used to search for a document in an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` @@ -360,13 +360,13 @@ Used to search for a document in an index ___ -### updateSettings +#### updateSettings `**updateSettings**(indexName, settings): unknown` Used to update the settings of an index -#### Parameters +##### Parameters -#### Returns +##### Returns `unknown` diff --git a/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx b/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx index 78f08d379d..87797b796c 100644 --- a/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx +++ b/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx @@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### create +#### create `**create**(input, context?): Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>` This method is used to create a stock location. -#### Example +##### Example ```ts import { @@ -32,7 +32,7 @@ async function createStockLocation (name: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)> @@ -73,13 +73,13 @@ Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)> ___ -### delete +#### delete `**delete**(id, context?): Promise<void>` This method is used to delete a stock location. -#### Example +##### Example ```ts import { @@ -93,7 +93,7 @@ async function deleteStockLocation (id:string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void> @@ -134,13 +134,13 @@ Promise<void> ___ -### list +#### list `**list**(selector, config?, context?): Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]>` This method is used to retrieve a paginated list of stock locations based on optional filters and configuration. -#### Example +##### Example To retrieve a list of stock locations using their IDs: @@ -202,7 +202,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]> @@ -252,13 +252,13 @@ Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]> ___ -### listAndCount +#### listAndCount `**listAndCount**(selector, config?, context?): Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]>` This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters. -#### Example +##### Example To retrieve a list of stock locations using their IDs: @@ -320,7 +320,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]> @@ -370,13 +370,13 @@ Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]> ___ -### retrieve +#### retrieve `**retrieve**(id, config?, context?): Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>` This method is used to retrieve a stock location by its ID -#### Example +##### Example A simple example that retrieves a inventory item by its ID: @@ -412,7 +412,7 @@ async function retrieveStockLocation (id: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)> @@ -462,13 +462,13 @@ Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)> ___ -### update +#### update `**update**(id, input, context?): Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>` This method is used to update a stock location. -#### Example +##### Example ```ts import { @@ -486,7 +486,7 @@ async function updateStockLocation (id:string, name: string) { } ``` -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)> diff --git a/www/apps/docs/content/references/services/interfaces/ITaxCalculationStrategy.mdx b/www/apps/docs/content/references/services/interfaces/ITaxCalculationStrategy.mdx index 8dc8e5a82b..d8461dbc8d 100644 --- a/www/apps/docs/content/references/services/interfaces/ITaxCalculationStrategy.mdx +++ b/www/apps/docs/content/references/services/interfaces/ITaxCalculationStrategy.mdx @@ -8,14 +8,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### calculate +#### calculate `**calculate**(items, taxLines, calculationContext): Promise<number>` Calculates the tax amount for a given set of line items under applicable tax conditions and calculation contexts. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<number> diff --git a/www/apps/docs/content/references/services/interfaces/ITaxService.mdx b/www/apps/docs/content/references/services/interfaces/ITaxService.mdx index d187c941eb..482245f39a 100644 --- a/www/apps/docs/content/references/services/interfaces/ITaxService.mdx +++ b/www/apps/docs/content/references/services/interfaces/ITaxService.mdx @@ -12,13 +12,13 @@ items and shipping methods. ## Methods -### getTaxLines +#### getTaxLines `**getTaxLines**(itemLines, shippingLines, context): Promise<[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]>` Retrieves the numerical tax lines for a calculation context. -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]> diff --git a/www/apps/docs/content/references/services/interfaces/ITransactionBaseService.mdx b/www/apps/docs/content/references/services/interfaces/ITransactionBaseService.mdx index a2823f087c..4e77545917 100644 --- a/www/apps/docs/content/references/services/interfaces/ITransactionBaseService.mdx +++ b/www/apps/docs/content/references/services/interfaces/ITransactionBaseService.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### withTransaction +#### withTransaction `**withTransaction**(transactionManager?): [ITransactionBaseService](ITransactionBaseService.mdx)` -#### Parameters +##### Parameters -#### Returns +##### Returns [ITransactionBaseService](ITransactionBaseService.mdx) diff --git a/www/apps/docs/content/references/services/interfaces/IterableIterator.mdx b/www/apps/docs/content/references/services/interfaces/IterableIterator.mdx index c66547097e..7b539c9041 100644 --- a/www/apps/docs/content/references/services/interfaces/IterableIterator.mdx +++ b/www/apps/docs/content/references/services/interfaces/IterableIterator.mdx @@ -22,11 +22,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### [iterator] +#### [iterator] `**[iterator]**(): [IterableIterator](IterableIterator.mdx)<T>` -#### Returns +##### Returns [IterableIterator](IterableIterator.mdx)<T> @@ -44,11 +44,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ___ -### next +#### next `**next**(...args): [IteratorResult](../types/IteratorResult.mdx)<T, any>` -#### Parameters +##### Parameters -#### Returns +##### Returns [IteratorResult](../types/IteratorResult.mdx)<T, any> @@ -80,11 +80,11 @@ ___ ___ -### return +#### return `Optional **return**(value?): [IteratorResult](../types/IteratorResult.mdx)<T, any>` -#### Parameters +##### Parameters -#### Returns +##### Returns [IteratorResult](../types/IteratorResult.mdx)<T, any> @@ -116,11 +116,11 @@ ___ ___ -### throw +#### throw `Optional **throw**(e?): [IteratorResult](../types/IteratorResult.mdx)<T, any>` -#### Parameters +##### Parameters -#### Returns +##### Returns [IteratorResult](../types/IteratorResult.mdx)<T, any> diff --git a/www/apps/docs/content/references/services/interfaces/Iterator.mdx b/www/apps/docs/content/references/services/interfaces/Iterator.mdx index 9e22e7a648..6ab66e8cd3 100644 --- a/www/apps/docs/content/references/services/interfaces/Iterator.mdx +++ b/www/apps/docs/content/references/services/interfaces/Iterator.mdx @@ -40,11 +40,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### next +#### next `**next**(...args): [IteratorResult](../types/IteratorResult.mdx)<T, TReturn>` -#### Parameters +##### Parameters -#### Returns +##### Returns [IteratorResult](../types/IteratorResult.mdx)<T, TReturn> @@ -76,11 +76,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ___ -### return +#### return `Optional **return**(value?): [IteratorResult](../types/IteratorResult.mdx)<T, TReturn>` -#### Parameters +##### Parameters -#### Returns +##### Returns [IteratorResult](../types/IteratorResult.mdx)<T, TReturn> @@ -112,11 +112,11 @@ ___ ___ -### throw +#### throw `Optional **throw**(e?): [IteratorResult](../types/IteratorResult.mdx)<T, TReturn>` -#### Parameters +##### Parameters -#### Returns +##### Returns [IteratorResult](../types/IteratorResult.mdx)<T, TReturn> diff --git a/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx b/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx index 9793735e63..59f28c36b9 100644 --- a/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx @@ -71,7 +71,7 @@ A money amount's data. A money amount represents a price. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": true, + "expandable": false, "children": [] } ]} /> diff --git a/www/apps/docs/content/references/services/interfaces/PaymentProcessor.mdx b/www/apps/docs/content/references/services/interfaces/PaymentProcessor.mdx index 02d11df082..1c20de71e0 100644 --- a/www/apps/docs/content/references/services/interfaces/PaymentProcessor.mdx +++ b/www/apps/docs/content/references/services/interfaces/PaymentProcessor.mdx @@ -11,13 +11,13 @@ This work is still experimental and can be changed until it becomes stable ## Methods -### authorizePayment +#### authorizePayment `**authorizePayment**(paymentSessionData, context): Promise<[PaymentProcessorError](PaymentProcessorError.mdx) \| { data: Record<string, unknown> ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) }>` Authorize an existing session if it is not already authorized -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentProcessorError](PaymentProcessorError.mdx) \| { data: Record<string, unknown> ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) }> @@ -58,13 +58,13 @@ Promise<[PaymentProcessorError](PaymentProcessorError.mdx) \| { data: R ___ -### cancelPayment +#### cancelPayment `**cancelPayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)>` Cancel an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)> @@ -96,13 +96,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentPr ___ -### capturePayment +#### capturePayment `**capturePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)>` Capture an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)> @@ -134,13 +134,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentPr ___ -### deletePayment +#### deletePayment `**deletePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)>` Delete an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)> @@ -172,13 +172,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentPr ___ -### getIdentifier +#### getIdentifier `**getIdentifier**(): string` Return a unique identifier to retrieve the payment plugin provider -#### Returns +##### Returns `string` @@ -196,13 +196,13 @@ Return a unique identifier to retrieve the payment plugin provider ___ -### getPaymentStatus +#### getPaymentStatus `**getPaymentStatus**(paymentSessionData): Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>` Return the status of the session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)> @@ -234,13 +234,13 @@ Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)> ___ -### initiatePayment +#### initiatePayment `**initiatePayment**(context): Promise<[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)>` Initiate a payment session with the external provider -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)> @@ -272,13 +272,13 @@ Promise<[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProces ___ -### refundPayment +#### refundPayment `**refundPayment**(paymentSessionData, refundAmount): Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)>` Refund an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)> @@ -319,13 +319,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentPr ___ -### retrievePayment +#### retrievePayment `**retrievePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)>` Retrieve an existing session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)> @@ -357,13 +357,13 @@ Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentPr ___ -### updatePayment +#### updatePayment `**updatePayment**(context): Promise<void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)>` Update an existing payment session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)> @@ -395,13 +395,13 @@ Promise<void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [Payme ___ -### updatePaymentData +#### updatePaymentData `**updatePaymentData**(sessionId, data): Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)>` Update the session data for a payment session -#### Parameters +##### Parameters -#### Returns +##### Returns Promise<Record<string, unknown> \| [PaymentProcessorError](PaymentProcessorError.mdx)> diff --git a/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx b/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx index f973298ce7..b1f7bb5733 100644 --- a/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx +++ b/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx @@ -40,13 +40,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### slice +#### slice `**slice**(begin, end?): [SharedArrayBuffer](../index.md#sharedarraybuffer)` Returns a section of an SharedArrayBuffer. -#### Parameters +##### Parameters -#### Returns +##### Returns [SharedArrayBuffer](../index.md#sharedarraybuffer) diff --git a/www/apps/docs/content/references/services/interfaces/SharedArrayBufferConstructor.mdx b/www/apps/docs/content/references/services/interfaces/SharedArrayBufferConstructor.mdx index 253aa18013..fd941271b9 100644 --- a/www/apps/docs/content/references/services/interfaces/SharedArrayBufferConstructor.mdx +++ b/www/apps/docs/content/references/services/interfaces/SharedArrayBufferConstructor.mdx @@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Constructors -### constructor +#### constructor `**new SharedArrayBufferConstructor**(byteLength)` -#### Parameters +##### Parameters `: `Object` + **EmitData**: `Object` -### Type parameters +#### Type Parameters -### Type declaration +#### Type declaration `: `T` extends `U` ? `never` : `T` + **Exclude**: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U -### Type parameters +#### Type Parameters `: [Omit](Omit.mdx)<FindOneOptions<TEntity>, "where" \| "relations" \| "select"> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, "where" \| "relations" \| "select"> & ``{ order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] }`` + **ExtendedFindConfig**: [Omit](Omit.mdx)<FindOneOptions<TEntity>, "where" \| "relations" \| "select"> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, "where" \| "relations" \| "select"> & ``{ order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] }`` -### Type parameters +#### Type Parameters `: [Omit](Omit.mdx)<FindOneOptions<TEntity>, "where" \| "relations" \| "select"> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, "where" \| "relations" \| "select"> & ``{ order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] }`` + **ExtendedFindConfig**: [Omit](Omit.mdx)<FindOneOptions<TEntity>, "where" \| "relations" \| "select"> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, "where" \| "relations" \| "select"> & ``{ order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] }`` -### Type parameters +#### Type Parameters `: [IteratorYieldResult](../interfaces/IteratorYieldResult.mdx)<T> \| [IteratorReturnResult](../interfaces/IteratorReturnResult.mdx)<TReturn> + **IteratorResult**: [IteratorYieldResult](../interfaces/IteratorYieldResult.mdx)<T> \| [IteratorReturnResult](../interfaces/IteratorReturnResult.mdx)<TReturn> -### Type parameters +#### Type Parameters `: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> + **Omit**: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> Construct a type with the properties of T except for those in type K. -### Type parameters +#### Type Parameters `: { [P in keyof T]?: T[P] } + **Partial**: { [P in keyof T]?: T[P] } Make all properties in T optional -### Type parameters +#### Type Parameters `: { [P in K]?: T[P] } + **PartialPick**: { [P in K]?: T[P] } -### Type parameters +#### Type Parameters `: { [P in K]: T[P] } + **Pick**: { [P in K]: T[P] } From T, pick a set of properties whose keys are in the union K -### Type parameters +#### Type Parameters `: [Selector](Selector.mdx)<TEntity> & ``{ q?: string }`` + **QuerySelector**: [Selector](Selector.mdx)<TEntity> & ``{ q?: string }`` -### Type parameters +#### Type Parameters `: { [P in K]: T } + **Record**: { [P in K]: T } Construct a type with a set of properties K of type T -### Type parameters +#### Type Parameters `) => Promise<any> \| `null` -### Type declaration +#### Type declaration `(query, variables?): Promise<any> \| null` diff --git a/www/apps/docs/content/references/services/types/ReorderConditions.mdx b/www/apps/docs/content/references/services/types/ReorderConditions.mdx index bfdafcab4b..93f506ab62 100644 --- a/www/apps/docs/content/references/services/types/ReorderConditions.mdx +++ b/www/apps/docs/content/references/services/types/ReorderConditions.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **ReorderConditions**: `Object` -### Type declaration +#### Type declaration `: { [P in keyof T]-?: T[P] } + **Required**: { [P in keyof T]-?: T[P] } Make all properties in T required -### Type parameters +#### Type Parameters `: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator<TEntity[key][] \| string \| string[]> } + **Selector**: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator<TEntity[key][] \| string \| string[]> } -### Type parameters +#### Type Parameters `: (`data`: `T`, `eventName`: `string`) => Promise<void> + **Subscriber**: (`data`: `T`, `eventName`: `string`) => Promise<void> -### Type parameters +#### Type Parameters -### Type declaration +#### Type declaration `(data, eventName): Promise<void>` diff --git a/www/apps/docs/content/references/services/types/SubscriberContext.mdx b/www/apps/docs/content/references/services/types/SubscriberContext.mdx index 47d03b885d..ab4165ae84 100644 --- a/www/apps/docs/content/references/services/types/SubscriberContext.mdx +++ b/www/apps/docs/content/references/services/types/SubscriberContext.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **SubscriberContext**: `Object` -### Type declaration +#### Type declaration Promise<DeepPartial<[LineItem](../classes/LineItem.mdx)>> \| DeepPartial<[LineItem](../classes/LineItem.mdx)> -### Type declaration +#### Type declaration `(item?, quantity?, additional?): Promise<DeepPartial<[LineItem](../classes/LineItem.mdx)>> \| DeepPartial<[LineItem](../classes/LineItem.mdx)>` diff --git a/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx b/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx index 2e42dd0997..bf3d867adf 100644 --- a/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx +++ b/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx @@ -6,9 +6,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # TreeQuerySelector - **TreeQuerySelector**``: [QuerySelector](QuerySelector.mdx)<TEntity> & ``{ include_descendants_tree?: boolean }`` + **TreeQuerySelector**: [QuerySelector](QuerySelector.mdx)<TEntity> & ``{ include_descendants_tree?: boolean }`` -### Type parameters +#### Type Parameters `: `T` \| ``{ valueOf: Method valueOf }`` + **WithImplicitCoercion**: `T` \| ``{ valueOf: Method valueOf }`` -### Type parameters +#### Type Parameters `: `T` & { [Property in K]-?: T[Property] } + **WithRequiredProperty**: `T` & { [Property in K]-?: T[Property] } Utility type used to remove some optional attributes (coming from K) from a type T -### Type parameters +#### Type Parameters `) => `RequestHandler` -### Type declaration +#### Type declaration `(options): RequestHandler` diff --git a/www/apps/docs/content/references/services/types/middlewareType.mdx b/www/apps/docs/content/references/services/types/middlewareType.mdx index 22bb75430a..8a071cb6b1 100644 --- a/www/apps/docs/content/references/services/types/middlewareType.mdx +++ b/www/apps/docs/content/references/services/types/middlewareType.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **middlewareType**: `Object` -### Type declaration +#### Type declaration `: `T` extends `U` ? `never` : `T` + **Exclude**: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U -### Type parameters +#### Type Parameters `: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> + **Omit**: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>> Construct a type with the properties of T except for those in type K. -### Type parameters +#### Type Parameters `: { [P in K]: T[P] } + **Pick**: { [P in K]: T[P] } From T, pick a set of properties whose keys are in the union K -### Type parameters +#### Type Parameters `: { [P in K]: T } + **Record**: { [P in K]: T } Construct a type with a set of properties K of type T -### Type parameters +#### Type Parameters diff --git a/www/apps/docs/content/references/workflows/classes/LocalWorkflow.mdx b/www/apps/docs/content/references/workflows/classes/LocalWorkflow.mdx index 1d8daad7bf..5a722f12c9 100644 --- a/www/apps/docs/content/references/workflows/classes/LocalWorkflow.mdx +++ b/www/apps/docs/content/references/workflows/classes/LocalWorkflow.mdx @@ -13,6 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [assertHandler](../LocalWorkflow/methods/LocalWorkflow.assertHandler.mdx) - [commit](../LocalWorkflow/methods/LocalWorkflow.commit.mdx) - [deleteAction](../LocalWorkflow/methods/LocalWorkflow.deleteAction.mdx) +- [getFlow](../LocalWorkflow/methods/LocalWorkflow.getFlow.mdx) - [insertActionAfter](../LocalWorkflow/methods/LocalWorkflow.insertActionAfter.mdx) - [insertActionBefore](../LocalWorkflow/methods/LocalWorkflow.insertActionBefore.mdx) - [mergeActions](../LocalWorkflow/methods/LocalWorkflow.mergeActions.mdx) diff --git a/www/apps/docs/content/references/workflows/types/ReturnWorkflow.mdx b/www/apps/docs/content/references/workflows/types/ReturnWorkflow.mdx index ca2cd3e111..75f4aa3333 100644 --- a/www/apps/docs/content/references/workflows/types/ReturnWorkflow.mdx +++ b/www/apps/docs/content/references/workflows/types/ReturnWorkflow.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ReturnWorkflow - **ReturnWorkflow**: ``(`container?`: [MedusaContainer](MedusaContainer.mdx) \| ``{ __definition: [ModuleDefinition](ModuleDefinition.mdx) ; __joinerConfig: [ModuleJoinerConfig](ModuleJoinerConfig.mdx) }``[]) => Omit<[LocalWorkflow](../classes/LocalWorkflow.mdx), "run"> & ``{ run: (args?: [FlowRunOptions](FlowRunOptions.mdx)<TDataOverride extends undefined ? TData : TDataOverride>) => Promise<[WorkflowResult](WorkflowResult.mdx)<TResultOverride extends undefined ? TResult : TResultOverride>> }`` & `THooks` + **ReturnWorkflow**: ``(`container?`: [MedusaContainer](MedusaContainer.mdx) \| ``{ __definition: [ModuleDefinition](ModuleDefinition.mdx) ; __joinerConfig: [ModuleJoinerConfig](ModuleJoinerConfig.mdx) }``[]) => Omit<[LocalWorkflow](../classes/LocalWorkflow.mdx), "run"> & ``{ run: (args?: [FlowRunOptions](FlowRunOptions.mdx)<TDataOverride extends undefined ? TData : TDataOverride>) => Promise<[WorkflowResult](WorkflowResult.mdx)<TResultOverride extends undefined ? TResult : TResultOverride>> }`` & `THooks` & ``{ getName: () => string }`` An exported workflow, which is the type of a workflow constructed by the [createWorkflow](../functions/createWorkflow.mdx) function. The exported workflow can be invoked to create an executable workflow, optionally within a specified container. So, to execute the workflow, you must invoke the exported workflow, then run the